Skip to content

docs: rewrite README and fix requirements in docs/index.md - #76

Merged
biobo-bot[bot] merged 1 commit into
mainfrom
docs/readme
Oct 31, 2026
Merged

biobo-bot[bot] merged 1 commit into
mainfrom
docs/readme

Conversation

@sentomk

@sentomk sentomk commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

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

  • README hero: a short std::variant<int, std::string> match that shows a
    literal case, bindings whose values the handlers use, guards that pick
    the branch, and the _ fallback.
  • README Quick Tour restructured; new Core Concepts table.
  • New Requirements section taken from cmake/CheckCompilerVersion.cmake
    (GCC 11, Clang 12, AppleClang 14, MSVC 19.30, clang-cl 18).
  • Installation: vcpkg, FetchContent (v0.9.5), install + find_package.
  • Documents the PTN_* CMake options; adds a License section.
  • docs/index.md: correct the MSVC minimum (19.30 / VS2022) and drop the
    macOS claim (AppleClang 14 is CMake-checked but not tested in CI).

Testing

  • Compiled every C++ snippet in the new README with Clang in C++17 and
    C++20 using -Wall -Wextra -Werror, with asserts; all passed.

Supersedes #75.

biobo-bot[bot]
biobo-bot Bot previously approved these changes Oct 30, 2026

@biobo-bot biobo-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_17 on the target and all the listed PTN_* options exist in CMakeLists.txt.
  • The CI description matches the ci-full.yml matrix.
  • The docs/index.md fix (dropping "MSVC >= 2019" and the macOS platform claim) is correct.
  • The linked docs pages, AGENTS.md, SECURITY.md, LICENSE, and samples/ all resolve.

I left two small non-blocking nits inline. Approving.

Comment thread README.md Resolved
Comment thread README.md Resolved

@biobo-bot biobo-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@biobo-bot
biobo-bot Bot merged commit e3947da into main Oct 31, 2026
29 checks passed
@biobo-bot
biobo-bot Bot deleted the docs/readme branch October 31, 2026 03:14

@biobo-bot biobo-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant