[Docs]: new README_unix.md to be included into tar or zip archives, c… #14022

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

cisba commented at 6:50 AM on August 22, 2018: contributor
…ontaining link to sources repo, basic info, instructions to run the executable files, files list and description, licence.
```
This fixes [#8160](/bitcoin-bitcoin/8160/), fixes [#8161](/bitcoin-bitcoin/8161/), fixes [#11971](/bitcoin-bitcoin/11971/)
```
[Docs]: new README_unix.md to be included into tar or zip archives, containing link to sources repo, basic info, instructions to run the executable files, files list and description, licence.
This fixes #8160, fixes #8161, fixes #11971
948b811bb2
fanquake added the label Docs on Aug 22, 2018

in doc/README_unix.md:39 in 948b811bb2

  34 | +Unpack the files into a directory and run:
  35 | +
  36 | +- `bin/bitcoin-qt` (GUI) or
  37 | +- `bin/bitcoind` (headless)
  38 | +
  39 | +Note: bitcoin-qt is missing in arm tars.

laanwj commented at 10:13 AM on August 22, 2018:

I think this was resolved, at least for ARM64, in #13696

in doc/README_unix.md:43 in 948b811bb2
```
  38 | +
  39 | +Note: bitcoin-qt is missing in arm tars.
  40 | +
  41 | +### Files
  42 | +```
  43 | +./bin/bitcoin-cli (Command Line Interface)
```
laanwj commented at 10:50 AM on August 22, 2018:

would prefer this formatted as a list

./bin/bitcoin-cli (Command Line Interface)

./bin/bitcoind (headless daemon) ...
laanwj commented at 10:54 AM on August 22, 2018: member

not entirely decided on whether we want more platform-dependent READMEs: e.g. would be better to have one that is actively updated for every platform than heaps of them that eventually run out of date with teach other.

I think the main README.md already is, effectively, the UNIX one! so might be better to update that one.

The only reason that windows has a special README is because it deviates from the way things are done on UNIX-ish OSes in a few places.
cisba commented at 1:00 PM on August 22, 2018: contributor

Ok, I will make a new PR updating the main README.md
cisba closed this on Aug 22, 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
MarcoFalke locked this on Sep 8, 2021

Contributors

cisba

laanwj

Labels

Docs

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