bitcoin/doc
John Newbery 808ef36b89 [doc] Update thread information in developer docs 2020-04-15 12:02:39 -04:00
..
man
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md doc: Update webchat URLs in README.md 2020-04-02 13:09:55 +00:00
README_doxygen.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md
bips.md
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-openbsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-osx.md
build-unix.md
build-windows.md
dependencies.md
descriptors.md
developer-notes.md [doc] Update thread information in developer docs 2020-04-15 12:02:39 -04:00
dnsseed-policy.md
files.md doc: Warn about wallet.dat re-use and backups 2020-03-10 01:51:03 +08:00
fuzzing.md doc: Add fuzzing quickstart guides for libFuzzer and afl-fuzz. Simplify instructions. 2020-03-18 22:32:01 +00:00
gitian-building.md
init.md
productivity.md doc: note the costs of fetching all pull requests 2020-03-31 14:42:09 +02:00
psbt.md
reduce-memory.md doc: block-relay-only is not blocksonly 2020-03-30 09:09:12 -04:00
reduce-traffic.md doc: block-relay-only is not blocksonly 2020-03-30 09:09:12 -04:00
release-notes.md build: Bump version to 0.20.99 2020-04-10 18:01:01 +02:00
release-process.md [doc] fix git add argument 2020-04-03 12:52:36 +02:00
shared-libraries.md
tor.md
translation_process.md
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.