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
Wladimir J. van der Laan 8d841ad492
doc: Remove MSVC update step from translation process
5 years ago
..
man Remove -mempoolreplacement to prevent needless block prop slowness. 5 years ago
release-notes Doc: move detached release notes into release-notes.md 5 years ago
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 8 years ago
Doxyfile.in doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE 5 years ago
JSON-RPC-interface.md doc: Clarify RPC versioning 6 years ago
README.md docs: add reduce-memory.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: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 5 years ago
assets-attribution.md
benchmarking.md [doc] Update and extend benchmarking.md 5 years ago
bips.md doc: Update bips 35, 37 and 111 status 5 years ago
bitcoin-conf.md doc: add default bitcoin.conf locations 5 years ago
bitcoin_logo_doxygen.png
build-freebsd.md doc: update FreeBSD build guide for 12.0 6 years ago
build-netbsd.md doc: update NetBSD build instructions for 8.0 6 years ago
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 6 years ago
build-osx.md doc: specify protobuf as optional in build docs 5 years ago
build-unix.md doc: clarify protobuf build requirements 5 years ago
build-windows.md Remove Windows 32 bit build 6 years ago
dependencies.md doc: clarify protobuf build requirements 5 years ago
descriptors.md Mention new descriptor RPCs in descriptors.md 6 years ago
developer-notes.md [doc] update brew instruction for doxygen 5 years ago
dnsseed-policy.md
files.md Add nice table to files.md 6 years ago
fuzzing.md Update doc and CI config 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 docs: Add productivity notes for "dummy rebases" 6 years ago
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 6 years ago
rapidcheck.md doc: initial RapidCheck property-based testing documentation 5 years ago
reduce-memory.md docs: add reduce-memory.md 5 years ago
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 6 years ago
release-notes-15584.md build: disable BIP70 support by default 5 years ago
release-notes-16185.md rpc: fix regression in gettransaction 5 years ago
release-notes-16512.md Shuffle inputs and outputs after joining psbts 5 years ago
release-notes-16695.md Add window final block height to getchaintxstats 5 years ago
release-notes-16787.md doc: add a release note for the new field in 'getpeerinfo' and 'getnetworkinfo' 5 years ago
release-notes.md Release notes: add previously undocumented changes 5 years ago
release-process.md doc: Remove explicit mention of version from SECURITY.md 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 doc: Remove MSVC update step from translation process 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. 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.