Add build instructions Add ids.yaml file to gitignore Make cmake automatically copy assets to build directory

3 files changed, 22 insertions, 0 deletions

@@ -1,5 +1,6 @@
 build/
 builds/
 assets/LL1.yaml
+assets/ids.yaml
 .DS_Store
 .vs
@@ -54,3 +54,13 @@ add_executable(lingo_ap_tracker
 set_property(TARGET lingo_ap_tracker PROPERTY CXX_STANDARD 20)
 set_property(TARGET lingo_ap_tracker PROPERTY CXX_STANDARD_REQUIRED ON)
 target_link_libraries(lingo_ap_tracker PRIVATE fmt::fmt OpenSSL::SSL OpenSSL::Crypto websocketpp::websocketpp wx::core wx::base wx::net yaml-cpp::yaml-cpp)
+
+set(SRC_DIR "${CMAKE_SOURCE_DIR}/assets")
+set(DST_DIR "${CMAKE_BINARY_DIR}/$<CONFIG>/assets")
+
+add_custom_target(copy_assets ALL
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${SRC_DIR} ${DST_DIR}
+    COMMENT "Copying folder from ${SRC_DIR} to ${DST_DIR}"
+)
+
+add_dependencies(lingo_ap_tracker copy_assets)
\ No newline at end of file
@@ -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