Reformat, add links, and slightly edit README file#6
Merged
Conversation
In an effort to bring more uniformity to project files, this reformats the file to follow Google Markdown style, with the exception of using 100 character line widths instead of Google's 80. Additional changes: - Add links to various things such as Stim docs, Wikipedia pages about the search algorithms, and so on. - Fix the heading for the usage section, which seems to have been accidentally merged into the first paragraph of that section. - Change the formating of the basic usage example to avoid using `<` and `>` characters, because those characters have meaning in shell syntax and could have led people to get hard-to-understand errors. - Make some style edits in some bullet lists, such as not capitalizing the text after colon characters.
This adds a statement about the vulnerability rewards program that Google's OSPO says should be put in the standard disclaimers.
noajshu
added a commit
that referenced
this pull request
Jun 23, 2025
…cument-changes Add configurable test modes
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.
In an effort to bring more uniformity to project files, this reformats the file to follow Google Markdown style, with the exception of using 100 character line widths instead of Google's 80.
Additional changes:
Add links to various things such as Stim docs, Wikipedia pages about the search algorithms, and so on.
Fix the heading for the usage section, which seems to have been accidentally merged into the first paragraph of that section.
Change the formating of the basic usage example to avoid using
<and>characters, because those characters have meaning in shell syntax and could have led people to get hard-to-understand errors.Make some style edits in some bullet lists, such as not capitalizing the text after colon characters.