1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0b928cd..cb3e90d 100644
--- a/README.md
+++ b/README.md

@@ -6,3 +6,26 @@ This app is a tool that helps you keep track of your game state when playing Lin
 ## Download
 Releases of the tracker can be found [on the releases page](https://code.fourisland.com/lingo-ap-tracker/about/CHANGELOG.md).
+## Acknowledgments
+* 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.
+### Using Visual Studio
+If you're using Visual Studio on Windows, you can simplify the above process. You can clone the repository directly from Visual Studio, and it will automatically download the submodules as well as configure cmake and build the vcpkg packages. You will still have to do steps 2 and 3 manually. Then, look for the dropdown next to the green arrow and select `lingo_ap_tracker.exe` so that you can build it. You can build in release mode by choosing it from the preset dropdown.

diff --git a/README.md b/README.md index 0b928cd..cb3e90d 100644 --- a/README.md +++ b/README.md
@@ -6,3 +6,26 @@ This app is a tool that helps you keep track of your game state when playing Lin
6	## Download	6	## Download
7		7
8	Releases of the tracker can be found [on the releases page](https://code.fourisland.com/lingo-ap-tracker/about/CHANGELOG.md).	8	Releases of the tracker can be found [on the releases page](https://code.fourisland.com/lingo-ap-tracker/about/CHANGELOG.md).
		9
		10	## Acknowledgments
		11
		12	* Brenton Wildes: Created Lingo, and drew some of the images used in the tracker.
		13	* Kinrah: Made the subway map image.
		14	* art0007i: Contributed to the display of the subway map.
		15
		16	## Building
		17
		18	To build the app:
		19
		20	1. Clone the repository including submodules: `git clone --recursive https://code.fourisland.com/lingo-ap-tracker`
		21	2. Put [LL1.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/LL1.yaml) in ./assets
		22	3. Put [ids.yaml from archipelago](https://github.com/ArchipelagoMW/Archipelago/raw/main/worlds/lingo/data/ids.yaml) in ./assets
		23	4. Configure the project: `cmake --preset=lingo-ap-tracker-preset`
		24	5. Build the application in debug mode: `cmake --build --preset=lingo-ap-tracker-preset`
		25	6. (Optional) Build the application in release mode: `cmake --build --preset=x64-release-preset`
		26
		27	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.
		28
		29	### Using Visual Studio
		30
		31	If you're using Visual Studio on Windows, you can simplify the above process. You can clone the repository directly from Visual Studio, and it will automatically download the submodules as well as configure cmake and build the vcpkg packages. You will still have to do steps 2 and 3 manually. Then, look for the dropdown next to the green arrow and select `lingo_ap_tracker.exe` so that you can build it. You can build in release mode by choosing it from the preset dropdown.