1 files changed, 16 insertions, 1 deletions

@@ -9,4 +9,19 @@ Releases of the tracker can be found [on the releases page](https://code.fourisl
 
 ## Acknowledgments
 
-Thanks to Kinrah for making the subway map image!
+* Brenton Wildes: Created Lingo, and drew some of the images used in the tracker.
+* Kinrah: Made the subway map image.
+* art0007i: Contributed to the display of the subway map.
+
+## Building
+
+To build the app:
+
+1. Clone the repository including submodules: `git clone --recursive https://code.fourisland.com/lingo-ap-tracker`
+2. Put [LL1.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/LL1.yaml) in ./assets
+3. Put [ids.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/ids.yaml) in ./assets
+4. Configure the project: `cmake --preset=lingo-ap-tracker-preset`
+5. Build the application in debug mode: `cmake --build --preset=lingo-ap-tracker-preset`
+6. (Optional) Build the application in release mode: `cmake --build --preset=x64-release-preset`
+
+LL1.yaml and ids.yaml sometimes receive breaking changes that need to be kept in sync with the tracker. If the application crashes with an unknown error, try making sure that you are using the right versions of those files. In general, the main branch of the tracker will require config files from the latest Archipelago release. Branches may require config files from Archipelago main, or from pending pull requests.