docs: updated README.md to include link to repo, files list and description #14026

pull cisba wants to merge 7 commits into bitcoin:master from cisba:fix-8160 changing 1 files +19 −1

cisba commented at 1:29 PM on August 22, 2018: contributor

This fixes #8160 (partially), fixes #8161, fixes #11971
[Docs]: updated README.md to be included into unix tar archives, containing files list and description.
This fixes #8160, fixes #8161, fixes #11971
c269e3da22
fanquake added the label Docs on Aug 22, 2018
randolf approved
laanwj renamed this:
~~[Docs]: updated README.md to be included into unix tar archives, cont…~~
[Docs]: updated README.md to be included into unix tar archives
on Aug 27, 2018
laanwj commented at 9:24 AM on August 27, 2018: member

This doesn't fix #8160 entirely, but combined with #14037 it does, I think (updated title).
laanwj renamed this:
~~[Docs]: updated README.md to be included into unix tar archives~~
[Docs]: updated README.md to include iles list and description
on Aug 27, 2018
laanwj commented at 9:28 AM on August 27, 2018: member

I'm not sure this fixes #8161? Does this add a link to the source repository so that people can find the source code easier?
[Docs]: updated README.md to be included into unix tar archives, containing link to repo, files list and description.
This fixes #8160, fixes #8161, fixes #11971
e1464e5bb3
cisba commented at 7:45 PM on August 30, 2018: contributor

Added the link to repo. Tell me if I have to rebase the PR.
cisba renamed this:
~~[Docs]: updated README.md to include iles list and description~~
[Docs]: updated README.md to include link to repo, files list and description
on Aug 31, 2018
in doc/README.md:101 in e1464e5bb3 outdated
```
  97 | @@ -81,4 +98,4 @@ License
  98 |  ---------------------
  99 |  Distributed under the [MIT software license](/COPYING).
 100 |  This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
 101 | -cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
 102 | +cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
```
fanquake commented at 9:40 AM on September 4, 2018:

What is changing here?

AkioNak commented at 10:29 AM on September 4, 2018:

It seems that the last '\n' has been deleted.

cisba commented at 2:00 PM on September 5, 2018:

Yes, not intentional but also not relevant (IMHO)...

fanquake commented at 1:22 AM on September 6, 2018:

@cisba Sure, however as a general rule, we try to keep unrelated/unintentional changes to a minimum (in all PRs), just to ease review. However in this case it's probably fine.

cisba commented at 5:45 AM on September 6, 2018:

@fanquake I restored the last '\n' and now it seem like I added a blank line... LOL

cisba commented at 12:08 PM on September 7, 2018:

fixed
fanquake renamed this:
~~[Docs]: updated README.md to include link to repo, files list and description~~
docs: updated README.md to include link to repo, files list and description
on Sep 4, 2018
hebasto commented at 7:24 PM on September 5, 2018: member

For the sake of style consistency all executables names should be either quoted within the backticks or not quoted at all.

docs: typos fixed

PR Title:
    docs: updated README.md to include link to repo, files list and
    description

PR Description:
    This fixes #8160 (partially), fixes #8161, see also PR #11971 and #14022

4f4c5af2fb

docs: typos f8dbc40197
cisba commented at 5:23 AM on September 6, 2018: contributor

Fixed typos pointed by @fanquake and @hebasto

PR Description should be: fixes #8160 (partially) with #14037, fixes #8161 (see also PR #11971 and #14022)
hebasto commented at 5:59 AM on September 6, 2018: member

For the sake of style consistency all executables names should be either quoted within the backticks or not quoted at all.

I meant bitcoin-qt.exe in the Running Windows section as well.
docs: bitcoin-qt.exe quoted as the others filenames c670c1992d
docs: typo 9023f7c813
docs: typo d998660577
in doc/README.md:25 in 9023f7c813 outdated
```
  21 | @@ -22,7 +22,7 @@ Unpack the files into a directory and run:
  22 |  
  23 |  ### Windows
  24 |  
  25 | -Unpack the files into a directory, and then run 
```
cisba commented at 7:36 AM on September 6, 2018:

trailing whitespace generated error in test/lint/lint-whitespace.sh https://travis-ci.org/bitcoin/bitcoin/jobs/425139871
cisba commented at 3:35 PM on September 7, 2018: contributor

@laanwj I think all points now are checked. Anyway, I made a new PR #14167 with the aim to improve even more the documentation in tar packages.
DrahtBot commented at 4:35 PM on September 7, 2018: member


The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #14167 ([WIP] docs: improve linux tar packages by cisba)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
merland commented at 7:12 AM on November 20, 2018: contributor

In PR 14755, I suggest to remove all instructions about running and instead link to the official docs, to avoid duplication. Currently in conflict with this PR. Review/comment requested.
(Also related: #14639)
fanquake commented at 10:30 AM on January 4, 2019: member

Closing this, given that #14167 includes these changes.
fanquake closed this on Jan 4, 2019
cisba deleted the branch on Mar 7, 2019
DrahtBot locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#8160 Binary release tarballs should come with a README #8161 Binary release doesn't make it easy to find the source code #11971 [docs]: include README with binary releases #14167 [WIP] docs: improve linux tar packages

docs: updated README.md to include link to repo, files list and description #14026

Conflicts