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 911a40ead2
Merge bitcoin/bitcoin#26557: build: Update Boost to 1.81.0 in depends
2 years ago
..
design doc: Rearrange some lines in the dependency graph of libraries 2 years ago
man
policy [doc] remove non-signaling mentions of BIP125 2 years ago
release-notes doc: add 23.1 release notes 2 years ago
.gitignore
Doxyfile.in Generate doxygen documentation for test sources 4 years ago
JSON-RPC-interface.md rpc: Allow named and positional arguments to be used together 2 years ago
README.md doc: consolidate & remove release-note fragments 2 years ago
README_doxygen.md
README_windows.txt
REST-interface.md Merge bitcoin/bitcoin#25412: rest: add `/deploymentinfo` endpoint 2 years ago
assets-attribution.md
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md doc: mention BIP86 in doc/bips.md 2 years ago
bitcoin-conf.md Security config warning 2 years ago
bitcoin_logo_doxygen.png
build-android.md build, qt: Use Android NDK r23 LTS 3 years ago
build-freebsd.md doc: mention that BDB is for the legacy wallet in build-freebsd.md 3 years ago
build-netbsd.md doc: update for NetBSD 9.2, add GUI Build Instructions 2 years ago
build-openbsd.md doc: Fix command in "OpenBSD Build Guide" 2 years ago
build-osx.md Revert "doc: note that brew installed qt is not supported" 2 years ago
build-unix.md doc: remove note on arm cross-compilation from build-unix.md 2 years ago
build-windows.md doc: Correct linked Microsoft URLs 2 years ago
cjdns.md Add and improve informational links in doc/cjdns.md 3 years ago
dependencies.md doc: Update Boost version in doc/dependencies.md 2 years ago
descriptors.md doc: correct deriveaddresses RPC name 2 years ago
developer-notes.md scripted-diff: rename CChainState -> Chainstate 2 years ago
dnsseed-policy.md
external-signer.md
files.md Ignore banlist.dat 3 years ago
fuzzing.md doc: Correct linked Microsoft URLs 2 years ago
guix.md
i2p.md doc: Add I2P bandwidth guidance to i2p.md 2 years ago
init.md
managing-wallets.md doc: Release notes and other docs for migration 2 years ago
multisig-tutorial.md doc: update multisig-tutorial.md to default wallet type 3 years ago
p2p-bad-ports.md init, doc: improve -onlynet help and tor/i2p documentation 3 years ago
productivity.md doc: add distcc to productivity notes 2 years ago
psbt.md doc: M-of-N multisig using descriptor wallets and PSBTs, as well as a signing flow 3 years ago
reduce-memory.md doc: update reduce-memory.md peer connections info 4 years ago
reduce-traffic.md
release-notes-19762.md rpc: Allow named and positional arguments to be used together 2 years ago
release-notes-22087.md Validate `port` options 2 years ago
release-notes-25412.md doc: add release note about `/rest/deploymentinfo` 2 years ago
release-notes-25730.md RPC: listunspent, add "include immature coinbase" flag 2 years ago
release-notes-25934.md doc: add release note for 25934 2 years ago
release-notes-26213.md bugfix: Strict type checking for RPC boolean parameters 2 years ago
release-notes-26265.md Add release note for MIN_STANDARD_TX_NONWITNESS_SIZE relaxation 2 years ago
release-notes-26628.md rpc: Make it an error server-side to specify same named parameter multiple times 2 years ago
release-notes-empty-template.md doc: Mac -> macOS in release notes template 2 years ago
release-process.md contrib: remove builder keys 2 years ago
shared-libraries.md
tor.md doc: update tor.md with cjdns and getnodeaddresses, fix tor grep, 3 years ago
tracing.md Fix: typos 2 years ago
translation_process.md doc: Remove unnecessary steps from translations update process 3 years ago
translation_strings_policy.md
zmq.md Update zmq.md: Fix parameter in hwm example block 2 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.