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 --- .gitignore | 1 + CMakeLists.txt | 10 ++++++++++ README.md | 11 +++++++++++ 3 files changed, 22 insertions(+) diff --git a/.gitignore b/.gitignore index a7cadc7..1ca77eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ build/ builds/ assets/LL1.yaml +assets/ids.yaml .DS_Store .vs diff --git a/CMakeLists.txt b/CMakeLists.txt index e1cb7f0..b168f5b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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}/$/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 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