forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #6120: docs: fix missing 'apt get install', make build steps mo…
…re prominent, format consistently 185e0fa doc: consistently use ```sh tags for correct shell highlighting (AJ ONeal) 3c198e0 doc: consistently use 'apt-get install' rather than 'apt install' (due to 'apt's sutble dependencies on interactive environment) (AJ ONeal) 22f7596 doc: add missing 'install' to 'apt-get' command (AJ ONeal) ea97482 doc: make build steps more prominent (AJ ONeal) Pull request description: 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 with `apt` in non-interactive scripts) - correct grammar `doc folder` => `./doc/` - make build / compile documentation prominent in README.md \ (easy to find via ctrl+f or scanning) - use `` ```sh `` consistently for shell formatting (rather than mixing `` ``, `` ```bash ``, `` ```shell ``, and `` ```sh `` ## How 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: - [x] I have performed a self-review of my own code - [x] ~~I have commented my code, particularly in hard-to-understand areas~~ - [x] ~~I have added or updated relevant unit/integration/functional/e2e tests~~ - [x] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: UdjinM6: utACK 185e0fa PastaPastaPasta: utACK 185e0fa Tree-SHA512: 5d05928568cdbc91dbce8090095f55e39c2453cc24dd2350333159e156efda31eac2d8a5ed5b39dc23eb9973057df60b1423e06077ee1bc2269d6235ed70c67a
- Loading branch information
Showing
2 changed files
with
91 additions
and
32 deletions.
There are no files selected for viewing
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
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