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
W. J. van der Laan b7565c708d
Merge bitcoin/bitcoin#22250: doc: add basic I2P documentation
3 years ago
..
man
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md doc: sort entries in doc/README.md#Miscellaneous alphabetically 3 years ago
README_doxygen.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md
bips.md
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-android.md
build-freebsd.md
build-netbsd.md
build-openbsd.md
build-osx.md doc: note that brew installed qt is not supported 4 years ago
build-unix.md
build-windows.md doc: improve note on choosing posix mingw32 4 years ago
dependencies.md build: set minimum required Boost to 1.64.0 3 years ago
descriptors.md Add tr() descriptor (derivation only, no signing) 4 years ago
developer-notes.md doc: remove obsolete `okSafeMode` RPC guideline from developer notes 3 years ago
dnsseed-policy.md
external-signer.md
files.md doc: fix grammar in doc/files.md 3 years ago
fuzzing.md doc: describe in fuzzing.md how to reproduce a CI crash 4 years ago
gitian-building.md
guix.md
i2p.md doc: add basic I2P documentation 3 years ago
init.md
multiprocess.md
productivity.md
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes.md doc: Final merge of release notes snippets 3 years ago
release-process.md doc: Fix external links (IRC, ...) 4 years ago
shared-libraries.md
tor.md doc: update tor.md with removal of tor v2 support 3 years ago
translation_process.md doc: Fix external links (IRC, ...) 4 years ago
translation_strings_policy.md
zmq.md

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.