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 6d5a9fec2d
Merge #19605: doc: set CC_FOR_BUILD when building on OpenBSD
4 years ago
..
man
release-notes doc: Add historical release notes for 0.20.1 4 years ago
.gitignore
Doxyfile.in [doc] include Doxygen comments for HAVE_BOOST_PROCESS 4 years ago
JSON-RPC-interface.md Replace `hidden service` with `onion service` 4 years ago
README.md
README_doxygen.md
README_windows.txt
REST-interface.md Merge #19390: doc/REST-interface: Remove stale info 4 years ago
assets-attribution.md
benchmarking.md Replace current benchmarking framework with nanobench 4 years ago
bips.md doc: list support for BIP 339 in doc/bips.md 4 years ago
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md
build-netbsd.md
build-openbsd.md doc: set CC_FOR_BUILD when building on OpenBSD 4 years ago
build-osx.md
build-unix.md
build-windows.md Add Windows WSL build recommendation to temporarily disable Win32 PE support. 4 years ago
dependencies.md build: set minimum required Boost to 1.58 4 years ago
descriptors.md
developer-notes.md Merge #19258: doc: improve subtree check instructions 4 years ago
dnsseed-policy.md
files.md Replace `hidden service` with `onion service` 4 years ago
fuzzing.md doc: afl fuzzing comment about afl-gcc and afl-g++ 4 years ago
gitian-building.md
init.md
multiprocess.md build: multiprocess autotools changes 5 years ago
productivity.md doc: Drop protobuf stuff 5 years ago
psbt.md
reduce-memory.md
reduce-traffic.md doc: Use precise permission flags where possible 4 years ago
release-notes-16525.md
release-notes.md gui, doc: rm Ban Score in GUI Peers window/release notes updates 4 years ago
release-process.md
shared-libraries.md
tor.md Replace `hidden service` with `onion service` 4 years ago
translation_process.md
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 5 years ago
zmq.md Add a link from ZMQ doc to ZMQ example in contrib/ 5 years ago

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.