Repository navigation
docs: rewrite README and fix requirements in docs/index.md - #76
Conversation
There was a problem hiding this comment.
Nice rewrite. The README is much easier to scan now, and the hero example finally shows binding ($(...)) and guards ([...]) with the bound values actually used in the handlers.
I checked the factual claims against the repo at this head:
- The compiler minimums match
cmake/CheckCompilerVersion.cmake(GCC 11, Clang 12, AppleClang 14, MSVC 19.30, clang-cl 18 with an MSVC 19.30+ toolset). cxx_std_17on the target and all the listedPTN_*options exist inCMakeLists.txt.- The CI description matches the
ci-full.ymlmatrix. - The
docs/index.mdfix (dropping "MSVC >= 2019" and the macOS platform claim) is correct. - The linked docs pages,
AGENTS.md,SECURITY.md,LICENSE, andsamples/all resolve.
I left two small non-blocking nits inline. Approving.
39c3c0e to
53189d2
Compare
There was a problem hiding this comment.
Both nits are fixed: the Performance Tuning link now points at https://patternia.tech/guide/performance-tuning/ (resolves, consistent with the other docs links), and PTN_DEV_INDEX is listed with the other CMake options, matching its description and default in CMakeLists.txt. Still a single commit over main. LGTM.
There was a problem hiding this comment.
Re-reviewed the force-pushed head (53189d2).
Both earlier nits are addressed: the Performance Tuning link now points at patternia.tech, and PTN_DEV_INDEX is listed with the other CMake options.
I extracted all eight cpp blocks from the README at this head and compiled them together against include/ in C++17 and C++20 with -Wall -Wextra: no errors or warnings. I also ran the top-of-README describe example and checked its output for 0, -3, 5, "hi", and "" (zero, negative -3, positive 5, text: hi, empty).
The docs/index.md requirements now match cmake/CheckCompilerVersion.cmake, and all CI checks on this head are green.
LGTM, approving.
Summary
Rewrite README.md so it reflects the v0.9.5 API and the build/packaging
setup that actually exists, and fix the requirements listed in
docs/index.md.
Changes
std::variant<int, std::string>match that shows aliteral case, bindings whose values the handlers use, guards that pick
the branch, and the
_fallback.cmake/CheckCompilerVersion.cmake(GCC 11, Clang 12, AppleClang 14, MSVC 19.30, clang-cl 18).
find_package.PTN_*CMake options; adds a License section.macOS claim (AppleClang 14 is CMake-checked but not tested in CI).
Testing
C++20 using
-Wall -Wextra -Werror, with asserts; all passed.Supersedes #75.