diff options
| author | art0007i <art0007i@gmail.com> | 2024-09-24 10:40:12 +0200 |
|---|---|---|
| committer | Star Rauchenberger <fefferburbia@gmail.com> | 2024-09-24 09:38:22 -0400 |
| commit | 46f46b4caa0fbaba77ac2b2291d908d3bf81dd28 (patch) | |
| tree | e2dcdf31c1ca33bfd3748de0e658e9bd0e008bb8 /README.md | |
| parent | 86b4b06e78c5c71588c1b55273969a1327a6710a (diff) | |
| download | lingo-ap-tracker-46f46b4caa0fbaba77ac2b2291d908d3bf81dd28.tar.gz lingo-ap-tracker-46f46b4caa0fbaba77ac2b2291d908d3bf81dd28.tar.bz2 lingo-ap-tracker-46f46b4caa0fbaba77ac2b2291d908d3bf81dd28.zip | |
Add build instructions Add ids.yaml file to gitignore Make cmake automatically copy assets to build directory
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
| 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 | |||
| 10 | ## Acknowledgments | 10 | ## Acknowledgments |
| 11 | 11 | ||
| 12 | Thanks to Kinrah for making the subway map image! | 12 | Thanks to Kinrah for making the subway map image! |
| 13 | |||
| 14 | ## Building | ||
| 15 | |||
| 16 | To build the app: | ||
| 17 | |||
| 18 | 1. Clone the repository including submodules: `git clone --recursive https://code.fourisland.com/lingo-ap-tracker` | ||
| 19 | 2. Put [LL1.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/LL1.yaml) in ./assets | ||
| 20 | 3. Put [ids.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/ids.yaml) in ./assets | ||
| 21 | 4. Configure the project: `cmake --preset=lingo-ap-tracker-preset` | ||
| 22 | 5. Build the application in debug mode: `cmake --build --preset=lingo-ap-tracker-preset` | ||
| 23 | 6. (Optional) Build the application in release mode: `cmake --build --preset=x64-release-preset` \ No newline at end of file | ||