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
Ava Chow 89d34cffed
doc: Sync 28.0 release notes with website
1 month ago
..
design doc: Remove reference to resolved issue 3 months ago
man doc: generate manpages 1 month ago
policy [doc] update documentation for new mempoolfullrbf default 3 months ago
release-notes docs: Remove release 28.0 release notes fragments 2 months ago
.gitignore
Doxyfile.in
JSON-RPC-interface.md minor: remove unnecessary semicolons from RPC content type examples 5 months ago
README.md build, test, doc: Temporarily remove Android-related stuff 6 months ago
README_doxygen.md
README_windows.txt
REST-interface.md testnet: Introduce Testnet4 3 months ago
assets-attribution.md
benchmarking.md
bips.md docs: Add 379 and 387 to bips.md 2 months ago
bitcoin-conf.md system: use %LOCALAPPDATA% as default datadir on windows 6 months ago
bitcoin_logo_doxygen.png
build-freebsd.md doc: suggest only necessary Qt packages for installation on FreeBSD 7 months ago
build-netbsd.md doc: Update NetBSD Build Guide 6 months ago
build-openbsd.md doc: mention optional dependencies (qrencode, zmq) in OpenBSD build docs 3 months ago
build-osx.md doc: add LLVM instruction for macOS < 13 6 months ago
build-unix.md Merge bitcoin/bitcoin#29756: doc: Override `-g` properly to skip debugging information 7 months ago
build-windows.md Merge bitcoin/bitcoin#30580: doc: Add note about distro's `g++-mingw-w64-x86-64-posix` version 3 months ago
cjdns.md
dependencies.md build: Bump clang minimum supported version to 16 4 months ago
descriptors.md tests: improve wallet multisig descriptor test and docs 6 months ago
developer-notes.md Fix lint-spelling warnings 4 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 Merge bitcoin/bitcoin#29775: Testnet4 including PoW difficulty adjustment fix 3 months ago
fuzzing.md doc: remove references to disable-asm option now that it's gone 8 months ago
guix.md
i2p.md doc: i2p: improve `-i2pacceptincoming` mention 7 months ago
init.md Merge bitcoin/bitcoin#28167: init: Add option for rpccookie permissions (replace 26088) 4 months ago
managing-wallets.md Merge bitcoin/bitcoin#27064: system: use %LOCALAPPDATA% as default datadir on windows 6 months ago
multiprocess.md doc: Add multiprocess design doc 11 months ago
multisig-tutorial.md doc: remove obsolete mention and link to closed PR 3 months ago
offline-signing-tutorial.md doc: update signet faucet link in offline-signing-tutorial.md 8 months ago
p2p-bad-ports.md
productivity.md doc: Update ccache website link 3 months ago
psbt.md
reduce-memory.md
reduce-traffic.md doc: update/clarify max outbound connection count 11 months ago
release-notes.md doc: Sync 28.0 release notes with website 1 month ago
release-process.md testnet: Introduce Testnet4 3 months ago
tor.md doc: tor.md: use -bind=127.0.0.1:8334=onion for the Tor bind 3 months ago
tracing.md
translation_process.md doc: Update translation_process.md 9 months ago
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.