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
Lőrinc f0130ab1a1
doc: replace `-?` with `-h` for bench_bitcoin help
3 weeks ago
..
design doc: multiprocess documentation improvements 1 month ago
man build: Remove Autotools-based build system 2 months ago
policy [doc] update documentation for new mempoolfullrbf default 3 months ago
release-notes doc: Archive 28.0 release notes 1 month ago
CMakeLists.txt cmake: add USE_SOURCE_PERMISSIONS to all configure_file usage 2 months ago
Doxyfile.in cmake: Add `docs` build target 3 months ago
JSON-RPC-interface.md minor: remove unnecessary semicolons from RPC content type examples 5 months ago
README.md doc: update IBD requirements in doc/README.md 1 month ago
README_doxygen.md
README_windows.txt
REST-interface.md testnet: Introduce Testnet4 3 months ago
assets-attribution.md
assumeutxo.md doc: fix assumeutxo design doc link 2 months ago
benchmarking.md doc: replace `-?` with `-h` for bench_bitcoin help 3 weeks ago
bips.md docs: Add 379 and 387 to bips.md 2 months ago
bitcoin-conf.md doc: add testnet4 section header for config file 1 month ago
bitcoin_logo_doxygen.png
build-freebsd.md doc: Remove mention of natpmp build options 1 month ago
build-netbsd.md doc: Update for CMake-based build system 3 months ago
build-openbsd.md doc: Remove mention of natpmp build options 1 month ago
build-osx.md doc: drop LLVM install instructions 3 weeks ago
build-unix.md doc: Remove mention of natpmp build options 1 month ago
build-windows-msvc.md docs: Fix minor typo 2 months ago
build-windows.md doc: remove dependency install instructions from win docs 3 weeks ago
cjdns.md
dependencies.md Merge bitcoin/bitcoin#30527: Bump python minimum supported version to 3.10 3 weeks ago
descriptors.md Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2 months ago
developer-notes.md doc: Updating docs from autotools to cmake 2 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: fuzz: remove Honggfuzz NetDriver instructions 3 weeks 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: multiprocess documentation improvements 1 month ago
multisig-tutorial.md doc: Prepend 'build/' to binary paths under 'src/' in docs 2 months ago
offline-signing-tutorial.md doc: Prepend 'build/' to binary paths under 'src/' in docs 2 months ago
p2p-bad-ports.md
productivity.md doc: Update for CMake-based build system 3 months ago
psbt.md
reduce-memory.md
reduce-traffic.md doc: update/clarify max outbound connection count 11 months ago
release-notes-28358.md validation: drop maximum -dbcache 5 months ago
release-notes-empty-template.md build: Bump minimum supported macOS to 13.0 3 weeks ago
release-process.md doc: Update for CMake-based build system 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 tracing: cast block_connected duration to nanoseconds 2 months ago
translation_process.md doc: Updating docs from autotools to cmake 2 months ago
translation_strings_policy.md doc: Updating docs from autotools to cmake 2 months ago
zmq.md doc: correct the zmq automatic build info 1 month 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 several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days 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.