docs: Revamp main README.md and update docs. #1447
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
force-pushed
the
revamp_readme
branch
from
1757115
to
bcf8e61
Compare
dnldd
approved these changes
Sep 12, 2018
alexlyp
approved these changes
Sep 12, 2018
davecgh
force-pushed
the
revamp_readme
branch
from
bcf8e61
to
d6d9fbe
Compare
This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
davecgh
force-pushed
the
revamp_readme
branch
from
d6d9fbe
to
817373d
Compare
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 revamps the main
README.mdfile in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates thedocs/README.mdto remove some sections that do not apply to Decred and update some others to reflect reality.It also adds minimum recommended specifications for
dcrdto the mainREADME.mdand updates the build instruction for module-aware builds and the recent changes therun_test.shscript.Finally, it updates the contact information to point to the decred.org/community page.