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 fac0ed16ec
doc: Sync "how to upgrade" with 0.20.0 release notes
5 years ago
..
man
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md
README_doxygen.md
README_windows.txt
REST-interface.md fix: update rest info on block size and json 5 years ago
assets-attribution.md
benchmarking.md
bips.md
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md
build-netbsd.md
build-openbsd.md
build-osx.md
build-unix.md
build-windows.md doc : add link to readme.md in the first section 5 years ago
dependencies.md
descriptors.md
developer-notes.md
dnsseed-policy.md
files.md
fuzzing.md doc: add c++17-enable to fuzzing instructions 5 years ago
gitian-building.md
init.md
multiprocess.md build: multiprocess autotools changes 5 years ago
productivity.md doc: Drop protobuf stuff 5 years ago
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-16528.md docs: Add release notes for descriptor wallets 5 years ago
release-notes-18918.md Add release notes about salvage changes 5 years ago
release-notes.md doc: Sync "how to upgrade" with 0.20.0 release notes 5 years ago
release-process.md
shared-libraries.md
tor.md
translation_process.md
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 5 years ago
zmq.md Add a link from ZMQ doc to ZMQ example in contrib/ 5 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.