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 b8d2f58e06
Merge bitcoin/bitcoin#30808: rpc: dumptxoutset height parameter follow-ups (29553)
2 months ago
..
design Merge bitcoin/bitcoin#30802: doc: Clarify libbitcoin_consensus in design/libraries.md 2 months ago
man build: Remove Autotools-based build system 2 months 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
CMakeLists.txt cmake: Add `docs` build target 3 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 for CMake-based build system 3 months ago
README_doxygen.md
README_windows.txt
REST-interface.md testnet: Introduce Testnet4 3 months ago
assets-attribution.md
assumeutxo.md doc: Add -rpcclienttimeout=0 to loadtxoutset examples 2 months ago
benchmarking.md doc: Update for CMake-based build system 3 months ago
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: add with_bdb to unix build docs 2 months ago
build-netbsd.md doc: Update for CMake-based build system 3 months ago
build-openbsd.md doc: remove extraneous install statement 2 months ago
build-osx.md doc: fix compiler flags for macOS configuration 2 months ago
build-unix.md Merge bitcoin/bitcoin#30779: doc: add `-DWITH_BDB=ON` to unix build docs 2 months ago
build-windows-msvc.md Fix a few likely documentation typos 2 months ago
build-windows.md doc: Update for CMake-based build system 3 months ago
cjdns.md doc: update getnodeaddresses for CJDNS, I2P and Tor and rm link 1 year ago
dependencies.md doc: replace Autotools with CMake 2 months 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 Merge bitcoin/bitcoin#30741: doc: update documentation and scripts related to build directories 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 scripted-diff: fuzz: Rename fuzz_seed_corpus to fuzz_corpora 2 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: 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 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-empty-template.md doc: add minimum required Linux Kernel to release-notes 11 months 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 doc: Prepend 'build/' to binary paths under 'src/' in docs 2 months 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.