docs: Root readme improvements #14961

pull ch4ot1c wants to merge 7 commits into bitcoin:master from ch4ot1c:improvements/readme changing 1 files +26 −19

ch4ot1c commented at 7:40 PM on December 14, 2018: contributor
Improvements to the repo's README.md
- Grammatical fixes
- Simple English
- Add note for building from source
- ~Add Travis and AppVeyor links~
- Unix as first-class
- Avoid parentheses
[docs] Readme: Updates to the 'What is Bitcoin?' section 76f74d73c2
[docs] Readme: Updates to 'Testing' section 30c65c72ce
[docs] Readme: Updates to 'Testing' subsections 3ae932ede3
[docs] Readme: Final readability improvements 821506d64a
[docs] Readme: Add paragraph and link for 'building from source' 15a02c262d
meshcollider added the label Docs on Dec 14, 2018

in README.md:39 in 15a02c262d outdated

  36 | -and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md).
  37 | +The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
  38 | +
  39 | +Useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md).
  40 | +
  41 | +Instructions for building Bitcoin Core from source are in [doc/build-unix.md](https://github.com/ch4ot1c/bitcoin/blob/improvements/readme/doc/build-unix.md#to-build).

meshcollider commented at 7:43 PM on December 14, 2018:

This refers to your repo

meshcollider commented at 7:46 PM on December 14, 2018: contributor

IMO this rewrite is a lot to review for small stylistic gain, so I'm a slight NACK here
[docs] Readme: Fixup fd8760db5f
[docs] Readme: Remove links to Travis and AppVeyor build servers e9f8384af9

in README.md:65 in 21378deec6 outdated

  73 | +Travis CI and AppVeyor CI make sure that every pull request is built for Linux, Windows,
  74 | +and macOS. Unit, integration, regression, and sanity tests are run automatically.
  75 |  
  76 | -The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.
  77 | +See https://travis-ci.org/bitcoin/bitcoin and https://ci.appveyor.com/project/DrahtBot/bitcoin
  78 | +to view output from the Travis and AppVeyor build servers.

MarcoFalke commented at 7:56 PM on December 14, 2018:

They are already linked from commits which were run and not linked for commits which are not run. No need to put them into the readme, imo.

ch4ot1c force-pushed on Dec 14, 2018
fanquake deleted a comment on Jan 4, 2019
fanquake renamed this:
~~[docs] Root readme improvements~~
docs: Root readme improvements
on Jan 4, 2019
fanquake commented at 10:48 AM on January 4, 2019: member

Agree with the NAK. Given that this is mostly re-formatting. Going to close for now.
fanquake closed this on Jan 4, 2019
DrahtBot locked this on Dec 16, 2021

Contributors

Labels