Update readme - #114
Open
drnick23 wants to merge 3 commits into
Open
Conversation
arvidn
approved these changes
Aug 25, 2026
arvidn
enabled auto-merge
August 25, 2026 11:43
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.
Note
Low Risk
Documentation-only changes with no runtime or build logic modified; incorrect CLI details could mislead users but do not affect shipped code.
Overview
Rewrites
README.mdto match the current repo layout (src/pos,src/common,src/tools/*, etc.) and documents all four binaries underbuild/(plotter,solver,prover,analytics), including optionalCP_ENABLE_*CMake switches.Adds an IMPORTANT callout that only
k=28is mainnet-valid, and replaces stub/outdated usage with full CLI reference: plottertestarguments and output naming, solver benchmark and xbits modes, prover check / challenge / verify, and analytics simdiskusage, hashbench, and simpreallocateplotgrouping. The tests section now includes explicitcmake/cteststeps and points torun-tests.sh -h.Reviewed by Cursor Bugbot for commit 3a10f95. Bugbot is set up for automated code reviews on this repo. Configure here.