From 24853a7e3bc239bb5d3d432af580ea2725525d1f Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Wed, 25 Oct 2023 20:17:41 +1100 Subject: [PATCH] Add events README.md --- v3/pkg/events/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 v3/pkg/events/README.md diff --git a/v3/pkg/events/README.md b/v3/pkg/events/README.md new file mode 100644 index 000000000..f9389f198 --- /dev/null +++ b/v3/pkg/events/README.md @@ -0,0 +1,14 @@ +# Events + +This package is used to generate the event management code and to allow quick addition of events. + +## Usage + +1. Add events to `events.txt` +2. Run `task generate:events` + +## Notes + +For events that you want to handle manually, add a `!` to the end of the event name and +add custom code into the appropriate platform. See [this PR](https://github.com/wailsapp/wails/pull/2991) +for an example of how to do this. \ No newline at end of file