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 dffefda21d
Merge #19870: doc: update PyZMQ install instructions, fix zmq_sub.py file permissions
4 years ago
..
man doc: remove OpenSSL from build instructions and licensing info 5 years ago
release-notes doc: Add historical release notes for 0.20.1 4 years ago
.gitignore
Doxyfile.in [doc] include Doxygen comments for HAVE_BOOST_PROCESS 4 years ago
JSON-RPC-interface.md Replace `hidden service` with `onion service` 4 years ago
README.md doc: Update webchat URLs in README.md 5 years ago
README_doxygen.md doc: Improve doxygen readme navigation section 5 years ago
README_windows.txt
REST-interface.md Merge #19390: doc/REST-interface: Remove stale info 4 years ago
assets-attribution.md
benchmarking.md Replace current benchmarking framework with nanobench 4 years ago
bips.md doc: list support for BIP 339 in doc/bips.md 4 years ago
bitcoin-conf.md doc: add default bitcoin.conf locations 5 years ago
bitcoin_logo_doxygen.png
build-freebsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-openbsd.md doc: set CC_FOR_BUILD when building on OpenBSD 4 years ago
build-osx.md Merge #18070: doc: add note about `brew doctor` 5 years ago
build-unix.md doc: remove Boost Chrono from install docs 5 years ago
build-windows.md Add Windows WSL build recommendation to temporarily disable Win32 PE support. 4 years ago
dependencies.md build: set minimum required Boost to 1.58 4 years ago
descriptors.md Output a descriptor in createmultisig and addmultisigaddress 5 years ago
developer-notes.md doc: Add best practice for annotating/asserting locks 4 years ago
dnsseed-policy.md
files.md Replace `hidden service` with `onion service` 4 years ago
fuzzing.md doc: afl fuzzing comment about afl-gcc and afl-g++ 4 years ago
gitian-building.md
init.md fixing documentation to not require rpcpassword 5 years ago
multiprocess.md build: multiprocess autotools changes 5 years ago
productivity.md doc: Drop protobuf stuff 5 years ago
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 6 years ago
reduce-memory.md doc: block-relay-only is not blocksonly 5 years ago
reduce-traffic.md doc: Use precise permission flags where possible 4 years ago
release-notes-14582.md doc: release notes for -maxapsfee 4 years ago
release-notes-15937.md wallet: Reload previously loaded wallets on GUI startup 4 years ago
release-notes-16525.md Additionally treat Tx.nVersion as unsigned in joinpsbts 5 years ago
release-notes-18244.md [rpc] fundrawtransaction, walletcreatefundedpsbt lock manually selected coins 4 years ago
release-notes-19405.md Add in/out connections to cli -getinfo 4 years ago
release-notes-19671.md Remove -zapwallettxes 4 years ago
release-notes-19731.md doc: release note for getpeerinfo last_block/last_transaction 4 years ago
release-notes.md Merge #19628: net: change CNetAddr::ip to have flexible size 4 years ago
release-process.md [doc] fix git add argument 5 years ago
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 6 years ago
tor.md Replace `hidden service` with `onion service` 4 years ago
translation_process.md build: Factor out qt translations from build system 5 years ago
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 5 years ago
zmq.md doc: update PyZMQ installation instructions, ZeroMQ link 4 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.