You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bitcoin/doc
fanquake c1fb30633b
Merge bitcoin/bitcoin#23114: Add minisketch subtree and integrate into build/test
3 years ago
..
man
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md doc: add assumeutxo notes 3 years ago
README_doxygen.md
README_windows.txt
REST-interface.md
assets-attribution.md
assumeutxo.md doc: add assumeutxo notes 3 years ago
benchmarking.md
bips.md doc: Add output script descriptors BIPs 380..386 3 years ago
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-android.md
build-freebsd.md
build-netbsd.md
build-openbsd.md
build-osx.md
build-unix.md doc: remove redundant optionals from build-unix.md 3 years ago
build-windows.md doc: remove WSL install instructions and point to upstream 3 years ago
dependencies.md doc: update minimum compiler requirements for std::filesystem 3 years ago
descriptors.md Merge bitcoin/bitcoin#22067: Test and document a basic M-of-N multisig using descriptor wallets and PSBTs 3 years ago
developer-notes.md Add minisketch dependency 3 years ago
dnsseed-policy.md
external-signer.md
files.md
fuzzing.md Add a brief overview of fuzzing/Bitcoin Core fuzzing 3 years ago
guix.md
i2p.md
init.md
managing-wallets.md
multiprocess.md
productivity.md
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-23093.md Add release notes for keypool flush changes 3 years ago
release-notes.md Merge bitcoin/bitcoin#22918: rpc: Add level 3 verbosity to getblock RPC call (#21245 modified) 3 years ago
release-process.md doc: Add note on deleting past-EOL release branches 3 years ago
shared-libraries.md
tor.md Merge bitcoin/bitcoin#22420: doc: Specifiy how to set the value of TORGROUP 3 years ago
tracing.md tracing: drop block_connected hash.toString() arg 3 years ago
translation_process.md
translation_strings_policy.md
zmq.md

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.