bitcoin/doc
glozow 39d111aee7
Merge bitcoin/bitcoin#25575: Address comments remaining from #25353
1056bbdfcd Address comments remaining from #25353 (Antoine Riard)

Pull request description:

  This PR should address the remaining comments from #25353.

ACKs for top commit:
  MarcoFalke:
    cr ACK 1056bbdfcd
  glozow:
    ACK 1056bbdfcd
  w0xlt:
    cr ACK 1056bbdfcd

Tree-SHA512: 194524193b1f087742c04d3cbe221e2ccf62e1f9303dc6668d62b73bd2dc0c039b7d68b33658dbee7809bd14bb8a5479f8e7928180b18c3180fdfbe3876c3ca1
2022-07-12 15:58:39 +01:00
..
design
man
policy Address comments remaining from #25353 2022-07-11 18:48:26 -04:00
release-notes doc: Add a release note about the "restore wallet" menu item 2022-07-01 10:16:42 -03:00
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md Merge bitcoin/bitcoin#24352: Add doc/design/libraries.md 2022-06-22 07:13:17 +02:00
README_doxygen.md
README_windows.txt
REST-interface.md doc: add reference to `getrawmempool` RPC in `/mempool/contents` REST doc 2022-04-20 18:12:39 -03:00
assets-attribution.md
benchmarking.md
bips.md
bitcoin-conf.md doc: update bitcoin-conf.md 2022-05-02 15:56:49 +02:00
bitcoin_logo_doxygen.png
build-android.md
build-freebsd.md doc: mention that BDB is for the legacy wallet in build-freebsd.md 2022-03-23 15:35:29 +00:00
build-netbsd.md doc: update for NetBSD 9.2, add GUI Build Instructions 2022-07-06 21:27:05 -04:00
build-openbsd.md doc: Fix command in "OpenBSD Build Guide" 2022-06-07 23:04:20 +02:00
build-osx.md Merge bitcoin/bitcoin#24585: doc: mention that BDB is for the legacy wallet in build-osx.md 2022-03-17 21:13:39 +01:00
build-unix.md doc: remove note on arm cross-compilation from build-unix.md 2022-07-05 14:09:36 -04:00
build-windows.md
cjdns.md Add and improve informational links in doc/cjdns.md 2022-04-01 16:11:14 +02:00
dependencies.md doc: add minimum required kernel version to dependencies.md 2022-04-28 09:56:03 +01:00
descriptors.md
developer-notes.md doc: update the URLs to thread functions in developer-notes 2022-07-11 09:56:24 +02:00
dnsseed-policy.md
external-signer.md
files.md
fuzzing.md
guix.md
i2p.md doc: update i2p.md with cjdns, improve local addresses section 2022-03-22 12:54:23 +01:00
init.md
managing-wallets.md
multisig-tutorial.md doc: update multisig-tutorial.md to default wallet type 2022-03-10 12:50:34 +01:00
p2p-bad-ports.md
productivity.md doc: add distcc to productivity notes 2022-06-13 16:13:11 +02:00
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-15936.md Add release notes about unified bitcoin-qt and bitcoind persistent settings 2022-05-26 11:05:10 -04:00
release-notes-24098.md Add release notes 2022-04-05 13:19:37 -04:00
release-notes-24118.md Add sendall RPC née sweep 2022-03-29 16:37:47 -04:00
release-notes-24198.md
release-notes-24494.md [doc] release notes for random change target 2022-03-25 11:57:51 +00:00
release-notes-empty-template.md doc: Add template for empty release notes 2022-03-17 14:15:07 +01:00
release-notes.md Address comments remaining from #25353 2022-07-11 18:48:26 -04:00
release-process.md Merge bitcoin/bitcoin#24424: doc: release process chainparams updates 2022-05-30 15:55:12 +02:00
shared-libraries.md
tor.md doc: update tor.md with cjdns and getnodeaddresses, fix tor grep, 2022-03-22 12:54:21 +01:00
tracing.md doc: document coin selection tracepoints 2022-04-21 11:11:02 -04:00
translation_process.md
translation_strings_policy.md
zmq.md Update zmq.md: Fix parameter in hwm example block 2022-05-25 23:49:15 +02:00

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license.