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 67eae69f3f
Merge bitcoin/bitcoin#23060: release: increase minimum compiler and lib(std)c++ requirements
3 years ago
..
man scripted-diff: Fix typo in stub manual pages 4 years ago
release-notes doc: Add historical release notes for 22.0 3 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 release: remove gitian 3 years ago
README_doxygen.md
README_windows.txt
REST-interface.md rpc: deprecate `addresses` and `reqSigs` from rpc outputs 4 years ago
assets-attribution.md
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md doc: Update bips.md for 0.21.1 4 years ago
bitcoin-conf.md doc: added info to bitcoin.conf doc 3 years ago
bitcoin_logo_doxygen.png
build-android.md Qt: add Android packaging support 4 years ago
build-freebsd.md docs: improve make with parallel jobs description. 4 years ago
build-netbsd.md docs: improve make with parallel jobs description. 4 years ago
build-openbsd.md script, doc: guix touchups 3 years ago
build-osx.md doc: note that brew installed qt is not supported 4 years ago
build-unix.md remove --enable-glibc-back-compat from CI and docs 3 years ago
build-windows.md doc: remove WSL install instructions and point to upstream 3 years ago
dependencies.md doc: update minimum compiler requirements for std::filesystem 3 years ago
descriptors.md doc: mention bech32m/BIP350 in doc/descriptors.md 3 years ago
developer-notes.md Enable TLS in links in documentation 3 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 test: Update test README and lint script 3 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
i2p.md Improve doc/i2p.md regarding I2P router options/versions 3 years ago
init.md doc: Replace tabs for spaces 4 years ago
managing-wallets.md Document about wallet backup and restoration 3 years ago
multiprocess.md multiprocess: Add comments and documentation 4 years ago
productivity.md doc: Add libnatpmp stuff 4 years ago
psbt.md
reduce-memory.md doc: update reduce-memory.md peer connections info 4 years ago
reduce-traffic.md
release-notes-12677.md doc/release-notes: Add new listunspent fields 3 years ago
release-notes-23065.md Add release note for lockunspent change 3 years ago
release-notes.md Merge bitcoin/bitcoin#23061: Fix (inverse) meaning of -persistmempool 3 years ago
release-process.md doc: Update snap release process for new versioning scheme 3 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md Merge bitcoin/bitcoin#22420: doc: Specifiy how to set the value of TORGROUP 3 years ago
tracing.md Remove GetAddrName 3 years ago
translation_process.md doc: Remove unnecessary steps from translations update process 3 years ago
translation_strings_policy.md
zmq.md doc: Add IPv6 address to zmq example 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.