Rewrite README for discovery and onboarding - #519
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: af425f12aa
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ```bash | ||
| cmake -S . -B build -DAE_BUILD_TESTS=ON | ||
| cmake --build build --parallel | ||
| ctest --test-dir build --output-on-failure |
There was a problem hiding this comment.
Keep test command compatible with CMake 3.16
This README advertises CMake 3.16+ above, but this command uses ctest --test-dir, and the CTest manual marks that option as "Added in version 3.20". Users on supported CMake 3.16–3.19 will hit an unsupported option when they try to run tests; either raise the documented minimum or use the existing cd <build-dir> && ctest . ... form.
Useful? React with 👍 / 👎.
Summary
Rewrites the README to improve GitHub discovery and make the repository easier to evaluate and use.
Draft for technical review before merging.