Update README.md

README.md

@@ -1,18 +1,21 @@
-# Super 2021 Swadge Firmware
-
-Continuous Integration: [![AEFeinstein](https://circleci.com/gh/AEFeinstein/Super-2021-Swadge-FW-Sandbox.svg?style=svg)](https://circleci.com/gh/AEFeinstein/Super-2021-Swadge-FW-Sandbox)
+# Super Magfest 2022 Swadge Firmware
 
 ## Welcome
 
-This is the firmware repository for the Super 2021 Swadge.
+This is the firmware repository for the Super Magfest 2022 Swadge.
+
+The corresponding hardware repository for the Super Magfest 2022 Swadge [can be found here](https://github.com/AEFeinstein/Super-2021-Swadge-HW).
+
+If you have any questions, feel free to create a Github ticket or email us at [email protected].
 
-The corresponding hardware repository for the Super 2021 Swadge Hardware [can be found here](https://github.com/AEFeinstein/Super-2021-Swadge-HW).
+## Continuous Integration
+[![AEFeinstein](https://circleci.com/gh/AEFeinstein/Super-2021-Swadge-FW-Sandbox.svg?style=svg)](https://circleci.com/gh/AEFeinstein/Super-2021-Swadge-FW-Sandbox)
 
 ## History 
 
-The Super 2021 Swadge is based on the [Super 2020 Swadge](https://github.com/AEFeinstein/Super-2020-Swadge-FW) and its [hardware repository](https://github.com/AEFeinstein/Super-2020-Swadge-HW).
+The Super Magfest 2022 Swadge is based on the [Super Magfest 2020 Swadge](https://github.com/AEFeinstein/Super-2020-Swadge-FW) and its [hardware repository](https://github.com/AEFeinstein/Super-2020-Swadge-HW).
 
-The Super 2020 Swadge is based on the [2019 Swadge](https://github.com/cnlohr/swadge2019). The 2019 Swadge has a combined firmware and hardware repository.
+The Super Magfest 2020 Swadge is based on the [2019 Swadge](https://github.com/cnlohr/swadge2019). The 2019 Swadge has a combined firmware and hardware repository.
 
 The 2019 Swadge is based on [ESP8266 Colorchord](https://github.com/cnlohr/colorchord/tree/master/embedded8266). You can read more about [ColorChord: Embedded here](https://github.com/AEFeinstein/Swadge-Devkit-Fw/blob/master/firmware/embeddedcommon/README.md).
 
@@ -22,8 +25,14 @@ ESP8266 Colorchord uses [esp8266ws2812i2s](https://github.com/cnlohr/esp8266ws28
 
 If you would like to work on this project, start by following the [Getting Started Guide](/docs/GETTING_STARTED.md). By the end of the guide you should have an enviroment where you can compile the firmware and flash it to a Swadge.
 
+There is also a [quick start script](/docs/swadge-setup.sh) which sets up a Linux environment (toolchain, dependencies, environment variables, and all) and builds the firmware.
+
 Once your environment is set up, read the [Contribution Guide](/docs/CONTRIBUTING.md). This guide outlines the best practices for getting your code into this project.
 
-The Super 2021 Swadge uses [cnlohr's exp8266 environment](https://github.com/cnlohr/esp82xx), which in turn uses the ESP8266 Non-OS SDK. You may find the [ESP8266 Non-OS SDK API Reference](https://www.espressif.com/sites/default/files/documentation/2c-esp8266_non_os_sdk_api_reference_en.pdf) useful.
+There are a few more guides on [how to add modes to the Swadge](/docs/ADDING_MODES.md), [how to save persistent data](/docs/SAVING_DATA.md), and [how to connect Swadges wirelessly](/docs/P2P_CONNECTION.md).
+
+The Super Magfest 2022 Swadge uses [cnlohr's exp8266 environment](https://github.com/cnlohr/esp82xx), which in turn uses the ESP8266 Non-OS SDK. You may find the [ESP8266 Non-OS SDK API Reference](https://www.espressif.com/sites/default/files/documentation/2c-esp8266_non_os_sdk_api_reference_en.pdf) useful.
 
 [pyFlashGui](/pyFlashGui) is used for flashing Swadges. It's a Python GUI program.
+
+[ESP Asset Packet](https://github.com/AEFeinstein/ESP-Asset-Packer) is used to process assets like png or gif files into a binary format which the Swadge firmware can use.