bitcoin/doc
W. J. van der Laan efd6f904c7
Merge bitcoin/bitcoin#22570: Ignore banlist.dat
fa1eddb1a3 Fix whitespace in touched files (MarcoFalke)
fa4e6afdae Remove unused CSubNet serialize code (MarcoFalke)
fa384fdd0b Ignore banlist.dat (MarcoFalke)

Pull request description:

  The code to read `banlist.dat` should be removed eventually. The major release (22.x) can be used to translate a `banlist.dat` into a `banlist.json`. Thus, it is now possible to remove the reading code.

ACKs for top commit:
  Zero-1729:
    re-ACK fa1eddb1a3
  laanwj:
    concept and code review ACK fa1eddb1a3
  vasild:
    ACK fa1eddb1a3
  jonatack:
    Light code review utACK fa1eddb1a3

Tree-SHA512: e136193b7c0ba1d6d2e79c7fb4106ba4af75fa229ed7214675ee64e98e59bb4808779e7a8a09eecce62f7a5d4bc6e16b8a5ad4596129357c8fc5e3b88f214249
2021-08-02 13:27:17 +02:00
..
man
release-notes
.gitignore
assets-attribution.md
benchmarking.md doc: update doc/benchmarking.md 2021-06-24 11:15:29 +02:00
bips.md
bitcoin_logo_doxygen.png
bitcoin-conf.md doc: added info to bitcoin.conf doc 2021-07-06 09:32:37 -04:00
build-android.md
build-freebsd.md
build-netbsd.md
build-openbsd.md script, doc: guix touchups 2021-07-23 21:23:37 +05:30
build-osx.md doc: note that brew installed qt is not supported 2021-05-17 21:36:08 -04:00
build-unix.md doc: document systemtap dependency 2021-07-27 16:33:43 +02:00
build-windows.md doc: improve note on choosing posix mingw32 2021-05-27 19:00:34 -04:00
dependencies.md doc: document systemtap dependency 2021-07-27 16:33:43 +02:00
descriptors.md Add tr() descriptor (derivation only, no signing) 2021-05-24 12:14:16 -07:00
developer-notes.md Merge bitcoin/bitcoin#18568: doc: Clarify developer notes about constant naming 2021-06-30 09:23:15 +08:00
dnsseed-policy.md
Doxyfile.in
external-signer.md
files.md Ignore banlist.dat 2021-07-30 11:21:51 +02:00
fuzzing.md Document faster throughput configuration 2021-07-28 13:03:08 -07:00
gitian-building.md
guix.md
i2p.md doc: add info to i2p.md about IBD time and multiple networks 2021-07-30 11:24:34 +02:00
init.md
JSON-RPC-interface.md
multiprocess.md
productivity.md
psbt.md
README_doxygen.md
README_windows.txt
README.md doc: doc/README.md IRC updates 2021-06-27 21:26:03 +02:00
reduce-memory.md
reduce-traffic.md
release-notes.md cli: Implement human readable -getinfo. 2021-07-21 19:27:04 +08:00
release-process.md guix, doc: Add a note that codesigners need to rebuild after tagging 2021-07-28 12:59:47 -04:00
REST-interface.md
shared-libraries.md
tor.md doc: update tor.md with removal of tor v2 support 2021-06-06 19:05:01 +02:00
tracing.md tracing: Tracepoint for connected blocks 2021-07-27 17:12:38 +02:00
translation_process.md doc: Remove unnecessary steps from translations update process 2021-07-03 21:31:29 +02:00
translation_strings_policy.md
zmq.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.