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 b1b1739944
Merge #18968: doc: noban precludes maxuploadtarget disconnects
5 years ago
..
man doc: remove OpenSSL from build instructions and licensing info 5 years ago
release-notes doc: Add release-notes-0.20.0.md 5 years ago
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 8 years ago
Doxyfile.in test: Add crc32c exception to various linters and generation scripts 5 years ago
JSON-RPC-interface.md doc: Clarify RPC versioning 6 years ago
README.md doc: Update webchat URLs in README.md 5 years ago
README_doxygen.md doc: Improve doxygen readme navigation section 5 years ago
README_windows.txt doc: Remove version numbers from READMEs 8 years ago
REST-interface.md fix: update rest info on block size and json 5 years ago
assets-attribution.md
benchmarking.md [doc] fix Makefile target in benchmarking.md 5 years ago
bips.md doc: Update doc/bips.md with recent changes in master 5 years ago
bitcoin-conf.md doc: add default bitcoin.conf locations 5 years ago
bitcoin_logo_doxygen.png
build-freebsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-openbsd.md doc: mention MAKE=gmake workaround when building on a BSD 5 years ago
build-osx.md Merge #18070: doc: add note about `brew doctor` 5 years ago
build-unix.md doc: remove Boost Chrono from install docs 5 years ago
build-windows.md doc : add link to readme.md in the first section 5 years ago
dependencies.md build: Set libevent minimum version to 2.0.21 5 years ago
descriptors.md Output a descriptor in createmultisig and addmultisigaddress 5 years ago
developer-notes.md [doc] Update thread information in developer docs 5 years ago
dnsseed-policy.md
files.md doc: Warn about wallet.dat re-use and backups 5 years ago
fuzzing.md build: turn on --enable-c++17 by --enable-fuzz 5 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
init.md fixing documentation to not require rpcpassword 5 years ago
multiprocess.md build: multiprocess autotools changes 5 years ago
productivity.md doc: Drop protobuf stuff 5 years ago
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 6 years ago
reduce-memory.md doc: block-relay-only is not blocksonly 5 years ago
reduce-traffic.md doc: noban precludes maxuploadtarget disconnects 5 years ago
release-notes-16528.md doc: Move 0.21 fragments into the main release notes 5 years ago
release-notes-18918.md doc: Move 0.21 fragments into the main release notes 5 years ago
release-notes.md doc: Move 0.21 fragments into the main release notes 5 years ago
release-process.md [doc] fix git add argument 5 years ago
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 6 years ago
tor.md Elaborate on the need to re-login on Debian-based systems to use tor following usermod 5 years ago
translation_process.md build: Factor out qt translations from build system 5 years ago
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.