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 920c090f63
Merge #14287: tests: Use MakeUnique to construct objects owned by unique_ptrs
6 years ago
..
man
release-notes doc: Add historical release notes for 0.16.3 6 years ago
.gitignore
Doxyfile.in
README.md
README_osx.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md
bips.md
bitcoin_logo_doxygen.png
build-freebsd.md
build-netbsd.md
build-openbsd.md
build-osx.md Remove reference to deprecated RPC call in build instructions 6 years ago
build-unix.md Add autogen.sh in ARM Cross-compilation 6 years ago
build-windows.md
dependencies.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 6 years ago
descriptors.md Add descriptor reference documentation 6 years ago
developer-notes.md Merge #14287: tests: Use MakeUnique to construct objects owned by unique_ptrs 6 years ago
dnsseed-policy.md
files.md
fuzzing.md
gitian-building.md
init.md
psbt.md
reduce-traffic.md
release-notes-13152.md [rpc] Add getnodeaddresses RPC command 6 years ago
release-notes-14023.md [wallet] Kill accounts 6 years ago
release-notes.md doc: release notes for -enablebip61 default change 6 years ago
release-process.md
shared-libraries.md
tor.md added note that control port must be enabled and how to do that in torrc config file 6 years ago
translation_process.md
translation_strings_policy.md
travis-ci.md
zmq.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 6 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 is currently more than 100 GBs); 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. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.