This is the firmware repository for the Super Magfest 2024 Swadge.
If you have any questions, feel free to create a Github ticket or email us at circuitboards@magfest.org.
This is living documentation, so if you notice that something is incorrect or incomplete, please fix or complete it, and submit a pull request!
Full Doxygen documentation is hosted online here. This details all APIs and has examples for how to use them. It was written to be referenced when writing Swadge modes.
The Contribution Guide can be found here. It should be read before making a contribution.
Our Code of Conduct is simple, but worth reading and adhering to.
This project uses Github Actions to automatically build the firmware, emulator, and documentation any time a change is pushed to main.
Reread the documentation, then search the internet for your issue, then ask about it either in a Github issue or the Slack channel, #circuitboards. If your problem is solved, then the solution should be added to the documentation in the appropriate place.