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 74e54cc2a3
Merge bitcoin/bitcoin#25917: depends: libnatpmp 07004b97cf691774efebe70404cf22201e4d330d
2 years ago
..
design scripted-diff: rename CChainState -> Chainstate 2 years ago
man scripted-diff: Fix typo in stub manual pages 4 years ago
policy [doc] remove non-signaling mentions of BIP125 2 years ago
release-notes doc: consolidate & remove release-note fragments 2 years ago
.gitignore
Doxyfile.in Generate doxygen documentation for test sources 4 years ago
JSON-RPC-interface.md Update 'Secure string handling' 4 years ago
README.md doc: consolidate & remove release-note fragments 2 years ago
README_doxygen.md doc: Improve doxygen readme navigation section 5 years ago
README_windows.txt
REST-interface.md doc: add reference to `getrawmempool` RPC in `/mempool/contents` REST doc 3 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md docs: Add 371 to 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: Install only "-posix" MinGW compiler when possible 3 years ago
cjdns.md Add and improve informational links in doc/cjdns.md 3 years ago
dependencies.md Merge bitcoin/bitcoin#25917: depends: libnatpmp 07004b97cf691774efebe70404cf22201e4d330d 2 years ago
descriptors.md doc: add `{import,list}descriptors` to list of descriptor RPCs 2 years ago
developer-notes.md scripted-diff: rename CChainState -> Chainstate 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 fuzz: parse the command line arguments in fuzz tests 3 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
i2p.md doc: document I2P transient addresses usage in doc/i2p.md 2 years ago
init.md doc: Replace tabs for spaces 4 years ago
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 doc: Use precise permission flags where possible 4 years ago
release-notes-empty-template.md doc: Add template for empty release notes 3 years ago
release-process.md Merge bitcoin/bitcoin#24424: doc: release process chainparams updates 2 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md doc: update tor.md with cjdns and getnodeaddresses, fix tor grep, 3 years ago
tracing.md doc: document coin selection tracepoints 3 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 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.