Add events README.md

This commit is contained in:
Lea Anthony 2023-10-25 20:17:41 +11:00
commit 24853a7e3b
No known key found for this signature in database
GPG key ID: 33DAF7BB90A58405

14
v3/pkg/events/README.md Normal file
View file

@ -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.