docs: Clarify README.md installation guides. #2171
Merged
Conversation
This file contains 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
davecgh
requested changes
Apr 21, 2020
matthawkins90
commented
Apr 21, 2020
davecgh
requested changes
Apr 21, 2020
|
Regarding the badges at the top of the README: Would it be better to link to the dcrd docs themselves? |
|
That version refers to the module version which is not the same as the overall software version. It is correct and up-to-date. |
davecgh
changed the title
davecgh
requested changes
Apr 21, 2020
There was a problem hiding this comment.
The modifications look good. Now, the commits just need to be squashed into a single commit and updated to match the Code Contribution Guidelines. Namely, the Model Git Commit Messages section.
I went ahead and modified the PR title accordingly.
davecgh
approved these changes
Apr 21, 2020
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.
This updates the primary
README.md.Latest Downloads:
Added clarifying text to inform new users how dcrd is differentiated from other Decred software.
The purpose is to guide people into the easier software bundles at https://decred.org/downloads, and only continue at dcrd if they truly desire.
What is dcrd?
Added clarifying text that dcrd does not include wallet functionality by itself.
Binaries
Again, trying to direct new users to https://decred.org/downloads, but added additional text to guide them into the docs.
Build from Source
Dependencies:
GOPATHandGOROOTare handled by default since Go 1.8, but many old Go tutorials direct users to play in dangerous waters. This text should help clarify that users don't need to mess with anything, and only Unix-based users need to mess with their $PATH environment variable.Further, clarified and reorganized instructions for both Windows and Unix-based users.
Running Tests
This was a sub-header under Docker, so I changed it to be its own header.