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
MarcoFalke f6c44e999b
Merge #21602: rpc: add additional ban time fields to listbanned
4 years ago
..
man scripted-diff: Fix typo in stub manual pages 4 years ago
release-notes Fix 0.21.0 release note to specify correct option BIP 157 support 4 years ago
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 8 years ago
Doxyfile.in configure: add --enable-external-signer 4 years ago
JSON-RPC-interface.md Update 'Secure string handling' 4 years ago
README.md Qt: add Android packaging support 4 years ago
README_doxygen.md doc: Improve doxygen readme navigation section 5 years ago
README_windows.txt doc: Remove version numbers from READMEs 8 years ago
REST-interface.md rpc: deprecate `addresses` and `reqSigs` from rpc outputs 4 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
benchmarking.md Replace current benchmarking framework with nanobench 4 years ago
bips.md Use Bech32m encoding for v1+ segwit addresses 4 years ago
bitcoin-conf.md doc: add signet to doc/bitcoin-conf.md 4 years ago
bitcoin_logo_doxygen.png Lossless image optimization 11 years ago
build-android.md Qt: add Android packaging support 4 years ago
build-freebsd.md doc: Update for FreeBSD 12.2, add GUI Build Instructions 4 years ago
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-openbsd.md doc: Add bash as an OpenBSD dependency 4 years ago
build-osx.md doc: revamp macOS build doc 4 years ago
build-unix.md doc: Update build instructions for Fedora 4 years ago
build-windows.md doc: Remove outdated comment 4 years ago
dependencies.md build: miniupnpc 2.2.2 4 years ago
descriptors.md docs: correctly identify script type 4 years ago
developer-notes.md refactor: Remove negative lock annotations from globals 4 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
external-signer.md doc: specify minimum HWI version 4 years ago
files.md init: introduce I2P connectivity options 4 years ago
fuzzing.md doc: Update fuzzing docs for afl-clang-lto 4 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
init.md doc: Replace tabs for spaces 4 years ago
multiprocess.md build: multiprocess autotools changes 5 years ago
productivity.md doc: Add libnatpmp stuff 4 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.md Merge #21602: rpc: add additional ban time fields to listbanned 4 years ago
release-process.md doc: Document use of make-tag script to make tags 4 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md doc: Replace tabs for spaces 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: Adjust ZMQ usage to support multiple interfaces 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.