Repository navigation
README: shorter, with the detail left to the docs and the FAQ - #216
Merged
Merged
Conversation
Requirements, install, first steps, updating and building repeated the docs pages nearly word for word. The README keeps the four install steps, the SmartScreen note and what the keyboard hook does, and links to the docs and the FAQ for the rest. The feature list is one or two lines an item and now has auto slots. The line about needs-testing checks for ZBrush 2023 and 2025 is gone: no open issue asks for one.
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.
The README repeated the docs pages nearly word for word: requirements, install, first steps, updating, uninstalling and building. It goes from about 1,870 words to about 1,050.
What stays in the README:
What it links to instead of repeating:
docs/install.mdfor what the installer changes, the SHA-256 file, updating, the portable zip, uninstalling and the upgrade from Radial Menu for ZBrush.docs/getting-started.mdfor the first steps in Studio.docs/building.mdandCONTRIBUTING.mdfor the rest of the build and for running from a checkout.Also gone: the line that said the needs-testing issues list quick checks for ZBrush 2023 and 2025. The only open issue with that label is #213, which is a measuring task.
The
Build from sourceheading keeps its name because the landing page links to#build-from-source.ring.pngandfan-out.gifare no longer in the README; the docs and the landing page still use them.No changelog line: nothing in the app changes.