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 3133d935ce
Merge bitcoin/bitcoin#27482: kernel: chainparams updates for 25.x
2 years ago
..
design docs: update assumeutxo.md 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
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
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-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 build: remove --enable-upnp-default from configure 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: correct sqlite & qrencode versions used in depenendencies.md 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
files.md
fuzzing.md doc: use arch agnostic clang path in fuzzing doc (macOS) 2 years ago
guix.md
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
reduce-memory.md doc: NetPermissionFlags for tx relay in blocksonly 2 years ago
reduce-traffic.md
release-note-26194.md rpc, wallet: use the same `next_index` in listdescriptors and importdescriptors 2 years ago
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-23395.md doc: Add release note for shutdownnotify. 2 years ago
release-notes-25375.md rpc: add minconf and maxconf options to sendall 2 years ago
release-notes-25412.md doc: add release note about `/rest/deploymentinfo` 2 years ago
release-notes-25574.md doc: add release note for #25574 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-25943.md Add release note for PR#25943 2 years ago
release-notes-25957.md doc: add release note for #25957 (fast wallet rescan) 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-26471.md doc: release note on mempool size in -blocksonly 2 years ago
release-notes-26618.md doc: Add release notes for #26618 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-26646.md doc: move errant release note to doc/ 2 years ago
release-notes-26896.md doc: add release notes for 26896 2 years ago
release-notes-26899.md doc: add release note for 26899 2 years ago
release-notes-27037.md doc: release notes for #27037 2 years ago
release-notes-27068.md doc: Release notes for 27068 2 years ago
release-notes-27217.md doc: Release note for purpose string restriction 2 years ago
release-notes-27279.md doc: release note for wallet RPCs "warning" field deprecation 2 years ago
release-notes-empty-template.md doc: Mac -> macOS in release notes template 2 years ago
release-process.md Merge bitcoin/bitcoin#27482: kernel: chainparams updates for 25.x 2 years ago
shared-libraries.md
tor.md doc: update DataDirectoryGroupReadable 1 in tor.md 2 years ago
tracing.md Add mempool tracepoints 2 years ago
translation_process.md
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.