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 d0bf9bb6a5
Merge bitcoin/bitcoin#23373: test: Parse command line arguments from unit and fuzz tests, make addrman consistency check ratio easier to change
3 years ago
..
man
policy [doc] CPFP carve out and single-conflict RBF exemption 3 years ago
release-notes doc: Add historical release notes for 22.0 3 years ago
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md Merge bitcoin/bitcoin#22674: validation: mempool validation and submission for packages of 1 child + parents 3 years ago
README_doxygen.md
README_windows.txt
REST-interface.md Update REST docs with new accessors 3 years ago
assets-attribution.md
assumeutxo.md doc: add assumeutxo notes 3 years ago
benchmarking.md
bips.md [doc] clarify RBF difference from BIP125 3 years ago
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-android.md build, qt: Use Android NDK r23 LTS 3 years ago
build-freebsd.md
build-netbsd.md
build-openbsd.md doc: remove CC_FOR_BUILD from OpenBSD build doc 3 years ago
build-osx.md build: use a static .tiff for macOS .dmg over generating 3 years ago
build-unix.md Fix Arch linux dead link 3 years ago
build-windows.md Merge bitcoin/bitcoin#22093: build: Try posix-specific CXX first for mingw32 host 3 years ago
dependencies.md Merge bitcoin/bitcoin#23724: build: add systemtap's sys/sdt.h as depends for GUIX builds with USDT tracepoints 3 years ago
descriptors.md Merge bitcoin/bitcoin#22067: Test and document a basic M-of-N multisig using descriptor wallets and PSBTs 3 years ago
developer-notes.md Improve fs::PathToString documentation 3 years ago
dnsseed-policy.md
external-signer.md
files.md
fuzzing.md fuzz: parse the command line arguments in fuzz tests 3 years ago
guix.md
i2p.md
init.md
managing-wallets.md
multiprocess.md
multisig-tutorial.md Add multisig tutorial 3 years ago
productivity.md
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes.md doc: Rework 14707 release notes 3 years ago
release-process.md build_msvc/bitcoin_config.h is generated using build_msvc/msvc-autogen.py 3 years ago
shared-libraries.md
tor.md Merge bitcoin/bitcoin#22420: doc: Specifiy how to set the value of TORGROUP 3 years ago
tracing.md [tracing] tracepoints to utxocache add, spent and uncache 3 years ago
translation_process.md
translation_strings_policy.md
zmq.md doc: Improve ZMQ documentation 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.