docs: add build instructions to README#174
Open
kimjune01 wants to merge 3 commits into
Open
Conversation
Resolves encounter#7 Added comprehensive build documentation covering: - Prerequisites (CMake 3.25+, C++20 compiler) - Building included examples - Integrating Aurora into game decomp projects - Available CMake options Verified on macOS with clang by successfully building the simple example.
…_USE_ZSTD option - Remove --recursive from clone command: repo uses FetchContent, not submodules - Document AURORA_CACHE_USE_ZSTD option (default: ON) that was missing from the list
Owner
|
Thanks for the PR! Would you mind moving this to docs/building.md and linking to it from the README.md? |
Author
|
Done — moved to docs/building.md and linked from the README. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AURORA_CACHE_USE_ZSTDFixes #7
Test plan
--recursiveflag (no submodules; deps use FetchContent)