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 4987cdd16d
Merge #14882: [doc] developer-notes.md: point out that UniValue deviates from upstream
6 years ago
..
man configure: Make it possible to build only one of bitcoin-cli or bitcoin-tx 6 years ago
release-notes doc: Add historical release notes for 0.17.0.1 6 years ago
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 8 years ago
Doxyfile.in doc: Make build system insert version in Doxyfile 8 years ago
JSON-RPC-interface.md doc: Add external interface consistency guarantees 6 years ago
README.md doc: Add external interface consistency guarantees 6 years ago
README_osx.md Rename “OS X” to the newer “macOS” convention 7 years ago
README_windows.txt doc: Remove version numbers from READMEs 8 years ago
REST-interface.md doc: Add external interface consistency guarantees 6 years ago
assets-attribution.md
benchmarking.md trivial: Fixed typos and cleaned up language 6 years ago
bips.md trivial: Fixed typos and cleaned up language 6 years ago
bitcoin-conf.md Add `doc/bitcoin-conf.md` 6 years ago
bitcoin_logo_doxygen.png
build-freebsd.md FreeBSD: Document Python 3 requirement for 'gmake check' 6 years ago
build-netbsd.md [doc] Create build-netbsd.md 7 years ago
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 6 years ago
build-osx.md [doc] conf: Remove deprecated options from docs, Other cleanup 6 years ago
build-unix.md Various textual improvements in build docs 6 years ago
build-windows.md Various textual improvements in build docs 6 years ago
dependencies.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 6 years ago
descriptors.md A few minor formatting fixes and clarifications to descriptors.md 6 years ago
developer-notes.md Merge #14882: [doc] developer-notes.md: point out that UniValue deviates from upstream 6 years ago
dnsseed-policy.md
files.md [doc] Include txindex changes in the release notes. 7 years ago
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 8 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
init.md Fix typos 6 years ago
psbt.md Add PSBT documentation 6 years ago
reduce-traffic.md trivial: Fixed typos and cleaned up language 6 years ago
release-notes-14060.md doc: add detached release notes for #14060 6 years ago
release-notes-14477.md Add release notes 6 years ago
release-notes-pr13381.md rpc: creates possibility to preserve labels on importprivkey 6 years ago
release-notes.md Release notes: integrate detached release notes 6 years ago
release-process.md Update release-process.md to include RC version bumping 6 years ago
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 8 years ago
tor.md Less confusing documentation for `torpassword` 6 years ago
translation_process.md Docs: Improve "of" grammar 6 years ago
translation_strings_policy.md Docs: Modify policy to not translate command-line help 6 years ago
travis-ci.md [doc] Rework docs 8 years ago
zmq.md ZMQ: add options to configure outbound message high water mark, aka SNDHWM 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 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. 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.