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
MarcoFalke 277abed604
Merge #15922: doc: Explain how to pass in non-fundamental types into functions
6 years ago
..
man Install bitcoin-wallet manpage. 6 years ago
release-notes doc: Add historical release notes for 0.18.0 6 years ago
.gitignore
Doxyfile.in
JSON-RPC-interface.md doc: Clarify RPC versioning 6 years ago
README.md travis: Properly cache and error on timeout 6 years ago
README_windows.txt
REST-interface.md rpc: Expose g_is_mempool_loaded via getmempoolinfo and /rest/mempool/info.json 6 years ago
assets-attribution.md
benchmarking.md
bips.md Update bips.md for 0.18.0 6 years ago
bitcoin-conf.md Add `doc/bitcoin-conf.md` 6 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: mention creating application support bitcoin folder on OSX 6 years ago
build-unix.md doc: Remove ppa from linux build instructions 6 years ago
build-windows.md Remove Windows 32 bit build 6 years ago
dependencies.md doc: describe onlynet option in doc/tor.md 6 years ago
descriptors.md Mention new descriptor RPCs in descriptors.md 6 years ago
developer-notes.md doc: Explain how to pass in non-fundamental types into functions 6 years ago
dnsseed-policy.md
files.md Add nice table to files.md 6 years ago
fuzzing.md qa: Add test/fuzz/test_runner.py 6 years ago
gitian-building.md
init.md init: Modify docs and add release note for 12255 6 years ago
productivity.md docs: Add productivity notes for "dummy rebases" 6 years ago
psbt.md Mention new PSBT RPCs in psbt.md 6 years ago
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 6 years ago
release-notes-14054.md [docs] release note for disabling reject messages by default 6 years ago
release-notes-14802.md rpc: faster getblockstats using BlockUndo data 6 years ago
release-notes-15006.md Add option to create an encrypted wallet 6 years ago
release-notes-15566.md cli: replace testnet with chain and return network name as per BIP70. 6 years ago
release-notes-15620.md doc: Add release notes for 15620 6 years ago
release-notes-15637.md rpc: Rename size to vsize in mempool related calls 6 years ago
release-notes-15730.md doc: Add release notes for 15730 6 years ago
release-notes-15849.md threads: prefix log messages with thread names 6 years ago
release-notes.md Merge #15870: wallet: Only fail rescan when blocks have actually been pruned 6 years ago
release-process.md [docs] Update release-process.md 6 years ago
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 6 years ago
tor.md doc: describe onlynet option in doc/tor.md 6 years ago
translation_process.md docs: Update Transifex links 6 years ago
translation_strings_policy.md A few textual improvements 6 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.