doc: Update blurb in README.md #25012

pull laanwj wants to merge 2 commits into bitcoin:master from laanwj:2022-04-readme-blurb changing 1 files +24 −11
  1. laanwj commented at 9:10 AM on April 28, 2022: member

    "What is bitcoin" is very much up for discussion. There's no need to try to resolve, nor explain that here, definitely not anymore. Replace it by a short, nonambigious blurb what this project is.

    (see also discussion here: #24951 (comment) , all in all it's just not up to us or this project to define, all we do is maintain code here)

  2. doc: Update blurb in README.md
    "What bitcoin is" is very much up for discussion. There's no need to try
    to resolve, nor explain that here, definitely not anymore. Replace it by
    a short, nonambigious blurb what this project is.
    e45a97869d
  3. laanwj added the label Docs on Apr 28, 2022
  4. in README.md:14 in e45a97869d outdated
      18 | -with no central authority: managing transactions and issuing money are carried
      19 | -out collectively by the network. Bitcoin Core is the name of open source
      20 | -software which enables the use of this currency.
      21 | -
      22 | -For more information read the original Bitcoin whitepaper.
      23 | +Bitcoin Core is a full node implementation for the Bitcoin P2P network. It also
    


    MarcoFalke commented at 9:16 AM on April 28, 2022:
    Bitcoin Core connects to the Bitcoin P2P network and fully validates blocks and transactions. It also
    

    "full node" might be unclear, so maybe explain that as well?


    laanwj commented at 9:19 AM on April 28, 2022:

    Do you have a short way of describing that?

  5. in README.md:19 in e45a97869d outdated
      23 | +Bitcoin Core is a full node implementation for the Bitcoin P2P network. It also
      24 | +includes a wallet and Qt-based graphical user interface, that can be
      25 | +optionally built.
      26 |  
      27 |  License
      28 |  -------
    


    MarcoFalke commented at 9:17 AM on April 28, 2022:

    As you are removing "experimental", could clarify that the software doesn't come with any warranty and users are using it at their own risk? (According to the MIT license)


    laanwj commented at 9:18 AM on April 28, 2022:

    "License" follows it, right? I also removed "open source".


    laanwj commented at 9:19 AM on April 28, 2022:

    It just doesn't describe Bitcoin anymore. Bitcoin might be experimental it might not be experimental, determining that is out of scope of this project.


    MarcoFalke commented at 9:20 AM on April 28, 2022:

    Sure, no strong opinion either way. I just thought it couldn't hurt to explain the warranty part to users that do not read the license (who does that?)


    laanwj commented at 9:21 AM on April 28, 2022:

    We could paste the entire MIT license into the License part. It's a few lines.


    MarcoFalke commented at 9:22 AM on April 28, 2022:

    I think one of the reasons to keep "experimental" was to make users more cautious and less yolo. I think caution still applies (and probably will forever).

  6. MarcoFalke approved
  7. MarcoFalke commented at 9:17 AM on April 28, 2022: member

    ACK. Left two nits.

  8. doc: Fully quote MIT license in README.md fe0389edee
  9. laanwj commented at 9:23 AM on April 28, 2022: member

    Closing this, this was a bad idea, I'm sorry.

  10. laanwj closed this on Apr 28, 2022

  11. laanwj locked this on Apr 28, 2022

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 15:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me