[docs]: include README with binary releases #11971

pull Varunram wants to merge 1 commits into bitcoin:master from Varunram:bindoc changing 1 files +56 −0

Varunram commented at 2:00 PM on December 21, 2017: contributor

Intended as a fix for: #8160 Suggestions welcome for a better file name, I couldn't think of any better ones, so went ahead with this. This file is more like a combination of the main readme at doc/README and some dev docs.
[docs]: include README with binary releases 66c68a0e98
laanwj commented at 2:06 PM on December 21, 2017: member

Thanks for your contribution, but this overlaps almost 100% with the existing README.md and doc/README.md with regard to content.

We should probably remove the content from there to make sure there is no overlap, or just add pointers to there instead.

What I meant in #8160, sorry if I was unclear, is that a README file should be part of the installation. That is still not the case after this, as it is a build system/packaging change.
laanwj added the label Docs on Dec 21, 2017
Varunram commented at 2:22 PM on December 21, 2017: contributor

I agree, this is an overlap as I mentioned in the description. But I don't quite get what you mean by "should be part of the installation" (pardon me if I'm being a little noob-ish). If you could elaborate more, that'd be nice. Thanks!
laanwj commented at 2:44 PM on December 21, 2017: member

But I don't quite get what you mean by "should be part of the installation" (pardon me if I'm being a little noob-ish)

I mean it should be part of the distributions generated by gitian, which are published on the site after a release. They are built by scripts, e.g. https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-descriptors/gitian-linux.yml
fanquake commented at 10:40 AM on January 29, 2018: member

Closing, as this PR doesn't currently fix #8160.
fanquake closed this on Jan 29, 2018
cisba referenced this in commit 948b811bb2 on Aug 22, 2018
cisba referenced this in commit c269e3da22 on Aug 22, 2018
cisba referenced this in commit e1464e5bb3 on Aug 30, 2018
cisba referenced this in commit 4f4c5af2fb on Sep 6, 2018
cisba referenced this in commit 4d7c29e1c6 on Sep 6, 2018
cisba referenced this in commit af69cb2d70 on Sep 6, 2018
cisba referenced this in commit 60ee12be43 on Feb 16, 2019
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#8160 Binary release tarballs should come with a README #14022 [Docs]: new README_unix.md to be included into tar or zip archives, c…#14026 docs: updated README.md to include link to repo, files list and description #14167 [WIP] docs: improve linux tar packages