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
Sawyer Billings e8640849c7
doc: Use https URLs where possible
4 years ago
..
man doc: Remove generated manual pages from master branch 4 years ago
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md Merge #19050: doc: Add warning for rest interface limitation 4 years ago
README.md
README_doxygen.md
README_windows.txt
REST-interface.md Merge #19050: doc: Add warning for rest interface limitation 4 years ago
assets-attribution.md
benchmarking.md
bips.md docs: mention BIPs 340-342 in doc/bips.md 4 years ago
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md doc: Update for FreeBSD 12.2, add GUI Build Instructions 4 years ago
build-netbsd.md
build-openbsd.md doc: Add bash as an OpenBSD dependency 4 years ago
build-osx.md doc: Update wallet database installation guide for macOS 4 years ago
build-unix.md Allow disabling BDB in configure with --without-bdb 4 years ago
build-windows.md
dependencies.md doc: Document current boost dependency as 1.71.0 4 years ago
descriptors.md docs/descriptors.md: Remove hardened marker in the path after xpub 4 years ago
developer-notes.md doc: Use https URLs where possible 4 years ago
dnsseed-policy.md
files.md Merge #20152: doc: Update wallet files in files.md 4 years ago
fuzzing.md fuzz: Link all targets once 4 years ago
gitian-building.md
init.md
multiprocess.md
productivity.md
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-19776.md
release-notes.md [doc] Add release notes for removed getpeerinfo fields. 4 years ago
release-process.md doc: Drop mentions of Travis CI as it is no longer used 4 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md Merge #19961: doc: tor.md updates 4 years ago
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.