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
merge-script 10f5022072
Merge bitcoin/bitcoin#29708: depends: build libnatpmp with CMake
7 months ago
..
design Merge bitcoin/bitcoin#29648: Remove libbitcoinconsensus 7 months ago
man
policy [doc] fix docs and comments from v3 9 months ago
release-notes doc: archive 27.0 release notes 7 months ago
.gitignore
Doxyfile.in
JSON-RPC-interface.md Update JSON-RPC-interface.md 1 year ago
README.md remove libbitcoinconsensus 8 months ago
README_doxygen.md
README_windows.txt
REST-interface.md Merge bitcoin/bitcoin#26207: rest: add verbose and mempool_sequence query params for mempool/contents 2 years ago
assets-attribution.md
benchmarking.md
bips.md doc: document that BIP324 on by default for v27.0 9 months ago
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-android.md
build-freebsd.md doc: suggest only necessary Qt packages for installation on FreeBSD 7 months ago
build-netbsd.md
build-openbsd.md doc: Suggest only necessary Qt packages for installation on OpenBSD 7 months ago
build-osx.md doc: remove mention of missing bdb being a configure error 12 months ago
build-unix.md Merge bitcoin/bitcoin#29756: doc: Override `-g` properly to skip debugging information 7 months ago
build-windows.md doc: remove mingw-w64 install for "older" systems 12 months ago
cjdns.md doc: update getnodeaddresses for CJDNS, I2P and Tor and rm link 1 year ago
dependencies.md depends: libnatpmp f2433bec24ca3d3f22a8a7840728a3ac177f94ba 7 months ago
descriptors.md doc: Add example of mixing private and public keys in descriptors 8 months ago
developer-notes.md [clang-tidy] Enable the misc-no-recursion check 7 months ago
dnsseed-policy.md Update the developer mailing list address. 7 months ago
external-signer.md wallet: compare address returned by displayaddress 7 months ago
files.md
fuzzing.md doc: remove references to disable-asm option now that it's gone 8 months ago
guix.md
i2p.md doc: simplify the router options in doc/i2p.md 1 year ago
init.md Remove `-sysperms` option 2 years ago
managing-wallets.md doc: explain what the wallet password does 7 months ago
multiprocess.md doc: Add multiprocess design doc 11 months ago
multisig-tutorial.md
offline-signing-tutorial.md doc: update signet faucet link in offline-signing-tutorial.md 8 months ago
p2p-bad-ports.md
productivity.md
psbt.md
reduce-memory.md doc: Be vague instead of wrong about MALLOC_ARENA_MAX 1 year ago
reduce-traffic.md doc: update/clarify max outbound connection count 11 months ago
release-notes-27114.md docs: add release notes for #27114 8 months ago
release-notes-27375.md doc: add release notes and help text for unix sockets 8 months ago
release-notes-27679.md doc: release notes for PR 27679 7 months ago
release-notes-empty-template.md doc: add minimum required Linux Kernel to release-notes 11 months ago
release-process.md doc: Add link to needs-release-notes label 11 months ago
tor.md Merge bitcoin/bitcoin#27719: doc: remove Tor link & generalize onion getnodeaddresses RPC 1 year ago
tracing.md Use `int32_t` type for most transaction size/weight values 1 year ago
translation_process.md doc: Update translation_process.md 9 months ago
translation_strings_policy.md
zmq.md validationinterface: only send zmq notifications for active 1 year 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.