From 46f46b4caa0fbaba77ac2b2291d908d3bf81dd28 Mon Sep 17 00:00:00 2001 From: art0007i Date: Tue, 24 Sep 2024 10:40:12 +0200 Subject: Add build instructions Add ids.yaml file to gitignore Make cmake automatically copy assets to build directory --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 83525dd..1e9b2a5 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,14 @@ Releases of the tracker can be found [on the releases page](https://code.fourisl ## Acknowledgments Thanks to Kinrah for making the subway map image! + +## 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` \ No newline at end of file -- cgit 1.4.1