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.
litecoin/doc
fanquake 516ebe8a62
Merge #18514: test: remove rapidcheck integration and tests
5 years ago
..
man doc: remove OpenSSL from build instructions and licensing info 5 years ago
release-notes doc: Add historical release notes for 0.19.1 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 doc: Remove explicit network name references 5 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
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: compiling with Visual Studio is now supported on Windows 5 years ago
dependencies.md doc: Update dependencies.md 5 years ago
descriptors.md Output a descriptor in createmultisig and addmultisigaddress 5 years ago
developer-notes.md doc: Add internal interface conventions to developer notes 5 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
files.md doc: Warn about wallet.dat re-use and backups 5 years ago
fuzzing.md doc: Add fuzzing quickstart guides for libFuzzer and afl-fuzz. Simplify instructions. 5 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
init.md doc: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 5 years ago
productivity.md doc: note the costs of fetching all pull requests 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: block-relay-only is not blocksonly 5 years ago
release-notes.md doc: Temporary note that release notes should be edited in wiki 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 A few textual improvements 6 years ago
zmq.md doc: Add note regarding ZMQ block notification 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.