Restyle README to house style#43
Merged
Merged
Conversation
House style: restructured tagline, shields.io badge row, --- separators before every section, sentence-case headers, an Overview heading for the intro, and a Contribute section linking CONTRIBUTING.md and SECURITY.md. Expanded the License section (GPL-3.0-only, VisorCraft LLC) with the THIRD_PARTY_NOTICES and LICENSES/ references. Code blocks and the docs table are byte-identical (verified).
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
1 participant
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
Restyles the existing
README.mdto the VisorCraft house style (it already had a centered logo + tagline; this adds the rest).---separators before every section; sentence-cased headers; wrapped the intro + architecture diagram under an Overview heading.CONTRIBUTING.mdandSECURITY.md.THIRD_PARTY_NOTICES.md+LICENSES/references.Fidelity
The architecture diagram, Quick start / Development code blocks, and the docs table are byte-identical to before (verified).