doc: Condense README.md #22205

pull workerl3 wants to merge 5 commits into bitcoin:master from workerl3:master changing 1 files +14 −35

workerl3 commented at 4:28 AM on June 10, 2021: none

I made a condensed Table of Contents format for the main github README.md in order to streamline the process for newer users. I found links to be repeated in some spots (src/test/README.md and /test in Automated Testing). The same information can be found elsewhere and in more context simply by visiting the link to the location needed by the user. The formatting is now similar to the documentation README.md

I added a separate file for Testing in order to not take up more space than necessary in the ToC.
condensed main page into toc, added separate testing doc cf110d2b9f
removed redundant Transifex url 2728b13683
fanquake closed this on Jun 10, 2021
fanquake reopened this on Jun 10, 2021
DrahtBot added the label Docs on Jun 10, 2021
in README.md:1 in 2728b13683 outdated
```
   0 | @@ -1,14 +1,12 @@
   1 | -Bitcoin Core integration/staging tree
   2 | +**Bitcoin Core Integration/Staging Tree**
```
laanwj commented at 10:01 AM on June 10, 2021:

There is no need to bold titles in markdown. The idea is to leave it up to the frontend how a certain style should look.

in README.md:20 in 2728b13683 outdated

  46 | -other people's pull requests, and remember this is a security-critical project where any mistake might cost people
  47 | -lots of money.
  48 | +For more information, read the original Bitcoin whitepaper.
  49 |  
  50 | -### Automated Testing
  51 | +[**Documents**](/doc) - Bitcoin Core Documentation

laanwj commented at 10:02 AM on June 10, 2021:

Same for links, by the way.

laanwj renamed this:
~~Condensed bitcoin core integration/staging tree~~
doc: Condense README.md
on Jun 10, 2021
in doc/testing.md:1 in 2728b13683 outdated
```
   0 | @@ -0,0 +1,16 @@
   1 | +**Testing**
```
MarcoFalke commented at 10:05 AM on June 10, 2021:

I think this can be moved to doc/README.md instead. I mean that a section for Testing can be created in the doc/README.md that collects all links to test related docs.
MarcoFalke commented at 10:06 AM on June 10, 2021: member

Seems fine to condense the "landing page" as long as all the info is linked to in another document.
workerl3 marked this as a draft on Jun 10, 2021
Merge branch 'bitcoin:master' into master 157964f60c
removed bolds, added testing section d5ea2a9bf5
Merge branch 'master' of https://github.com/brownit89/bitcoin-1 6eec62f932
workerl3 marked this as ready for review on Jun 11, 2021

fanquake commented at 1:06 AM on June 11, 2021: member

You need to squash your commits, and write a useful commit message, as well as address the linter failure:

This diff appears to have added new lines with trailing whitespace.
The following changes were suspected:

diff --git a/README.md b/README.md
@@ -25,2 +22 @@ License
+[Documents](/doc) - Bitcoin Core Documentation (see `doc/build-*.md` for instructions)
@@ -35,4 +29,2 @@ regularly from release branches to indicate new official, stable release version
+[Contributing Workflow](CONTRIBUTING.md) - Process/guidelines for contributing
@@ -53,8 +44 @@ lots of money.
+[Unit Tests](/src/test/README.md) - Developers are strongly encouraged to write unit tests for new code and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`.
^---- failure generated from test/lint/lint-whitespace.sh

MarcoFalke commented at 1:56 PM on July 7, 2021: member

Closing for now due to inactivity
MarcoFalke closed this on Jul 7, 2021
DrahtBot locked this on Aug 16, 2022

Contributors

Labels