Repository navigation
docs: rewrite README and fix requirements in docs/index.md - #75
Closed
biobo-bot[bot] wants to merge 1 commit into
Closed
biobo-bot[bot] wants to merge 1 commit into
biobo-bot[bot] wants to merge 1 commit into
Conversation
Contributor
Author
There was a problem hiding this comment.
Reviewed the README rewrite and the docs/index.md requirements fix. This looks good to me, and I have no blocking issues.
What I checked:
- The Requirements tables match
cmake/CheckCompilerVersion.cmake(GCC 11, Clang 12, AppleClang 14, MSVC 19.30, clang-cl 18 with an MSVC 19.30+ toolset). Correcting MSVC from "2019" to 19.30 / VS2022 is the right fix. - The
PTN_*options listed under Building the Tests matchCMakeLists.txt, and the "on by default only when top-level" note matchesPTN_MASTER_PROJECT. - The FetchContent tag is
v0.9.5, and the install +find_packageflow turns off tests, benchmarks, and samples, which is sensible for an install-only build. - The hero and Quick Tour examples use bindings whose values are actually consumed by the handlers, and the guards pick branches as intended. The note that
>>binds tighter than||/&&is correct C++ precedence. - The
PTN_ONscoping note keeps the important caveat from the old README (captureless lambda, so use namespace scope, C++20static, orPTN_BINDin C++17) in a shorter form. - CI on this head is green apart from a couple of jobs still running.
Two optional nits:
- The Performance Tuning link goes to GitHub while the other docs links go to patternia.tech. That's fine, since
guide/performance-tuning.mdisn't in themkdocs.ymlnav yet. If it gets added later, this link could switch over. PTN_DEV_INDEXisn't in the options list. That seems intentional, since it's an IDE-only target.
I'm leaving this as a comment rather than an approval because GitHub doesn't let a PR's author (Biobo Bot) approve its own pull request, so a maintainer needs to approve it.
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
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
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.structured-binding placeholders,
std::variant(is<T>/alt<I>),combinators, an event-dispatch example, and cached case packs.
cmake/CheckCompilerVersion.cmake(GCC 11, Clang 12, AppleClang 14, MSVC 19.30, clang-cl 18) plus the
compilers and standards covered by CI.
find_package,and subdirectory / include-path options.
PTN_*CMake options; adds a Licensesection and links to AGENTS.md and SECURITY.md.
list the CMake-checked minimums, and drop the macOS claim (AppleClang 14
is accepted by the CMake check but not tested in CI).
Testing
C++20 using
-Wall -Wextra -Werror, with asserts on the results; allpassed.
ptn_testslocally on this branch's base: all testspassed (the separate C++20 member-names target was not built).