docs: fix missing 'apt get install', make build steps more prominent, format consistently #6120
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
UdjinM6
approved these changes
Jul 17, 2024
Yes; we don't merge into master directly; please PR these changes to develop instead |
knst
changed the title
…e to 'apt's sutble dependencies on interactive environment)
|
Updated. I checked in ignore-whitespace mode to make sure no undesirable changes occurred: https://github.com/dashpay/dash/pull/6120/files?diff=unified&w=1 |
UdjinM6
approved these changes
Jul 18, 2024
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.
Developers come to Dash should have clear instruction for how to build / compile just by scanning the README.
Also, the instructions should be correct and consistent.
What was done?
apt-get=>apt-get install(fix typo)apt install=>apt-get install(due to subtle bugs withaptin non-interactive scripts)doc folder=>./doc/(easy to find via ctrl+f or scanning)
```shconsistently for shell formatting (rather than mixing```bash,```shell, and```shHow Has This Been Tested?
See https://github.com/dashhive/dash/tree/doc-build-docs.
Note that it's formatted well and consistently and the typos are fixed.
Breaking Changes
N/A
Only fixes here.
Checklist:
I have commented my code, particularly in hard-to-understand areasI have added or updated relevant unit/integration/functional/e2e tests