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 d5e06919db
random: switch to using getrandom() directly
2 years ago
..
design docs: update assumeutxo.md 2 years ago
man scripted-diff: Fix typo in stub manual pages 4 years ago
policy [policy] disallow transactions under min relay fee, even in packages 2 years ago
release-notes doc: add 24.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#26207: rest: add verbose and mempool_sequence query params for mempool/contents 2 years ago
assets-attribution.md
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md doc: remove version number from 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 Merge bitcoin/bitcoin#26773: doc: FreeBSD build doc updates to reflect removal of install_db4.sh 2 years ago
build-netbsd.md doc: update for NetBSD 9.2, add GUI Build Instructions 2 years ago
build-openbsd.md doc: update OpenBSD build docs for 7.3 (external signer support available) 2 years ago
build-osx.md Revert "doc: note that brew installed qt is not supported" 2 years ago
build-unix.md doc: remove Security section 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 random: switch to using getrandom() directly 2 years ago
descriptors.md doc: correct deriveaddresses RPC name 2 years ago
developer-notes.md Update developer-notes.md 2 years ago
dnsseed-policy.md
external-signer.md Move external signer out of wallet module 4 years ago
files.md Ignore banlist.dat 3 years ago
fuzzing.md doc: use arch agnostic clang path in fuzzing doc (macOS) 2 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
i2p.md doc: remove recommended I2P router versions 2 years ago
init.md Remove `-sysperms` option 2 years ago
managing-wallets.md Change dots to an ellipsis and fix capitalization 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: remove mention of glibc 2.10+ 2 years ago
reduce-traffic.md doc: Use precise permission flags where possible 4 years ago
release-notes-25158.md doc: add release notes for `abandoned` field in `gettransaction` and `listtransactions` 2 years ago
release-notes-26076.md doc: clarify PR 26076 release note 2 years ago
release-notes-26094.md rpc: return block hash & height in getbalances, gettransaction & getwalletinfo JSONs 2 years ago
release-notes-empty-template.md doc: Mac -> macOS in release notes template 2 years ago
release-process.md [doc] Add post branch-off note about fuzz input pruning 2 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md doc: update DataDirectoryGroupReadable 1 in tor.md 2 years ago
tracing.md Add mempool tracepoints 2 years ago
translation_process.md doc: Remove unnecessary steps from translations update process 3 years ago
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 5 years ago
zmq.md Update zmq.md: Fix parameter in hwm example block 3 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.