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 dca80ffb45
Merge #20255: util: Add Assume() identity function
4 years ago
..
man doc: Remove generated manual pages from master branch 4 years ago
release-notes doc: Add historical release notes for 0.20.1 4 years ago
.gitignore
Doxyfile.in [doc] include Doxygen comments for HAVE_BOOST_PROCESS 4 years ago
JSON-RPC-interface.md Replace `hidden service` with `onion service` 4 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
REST-interface.md Merge #19390: doc/REST-interface: Remove stale info 4 years ago
assets-attribution.md
benchmarking.md Replace current benchmarking framework with nanobench 4 years ago
bips.md docs: mention BIPs 340-342 in doc/bips.md 4 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: Add bash as an OpenBSD dependency 4 years ago
build-osx.md build: set minimum supported macOS to 10.14 4 years ago
build-unix.md Allow disabling BDB in configure with --without-bdb 4 years ago
build-windows.md Add Windows WSL build recommendation to temporarily disable Win32 PE support. 4 years ago
dependencies.md doc: Document current boost dependency as 1.71.0 4 years ago
descriptors.md docs/descriptors.md: Remove hardened marker in the path after xpub 4 years ago
developer-notes.md util: Add Assume() identity function 4 years ago
dnsseed-policy.md
files.md Merge #20152: doc: Update wallet files in files.md 4 years ago
fuzzing.md doc: afl fuzzing comment about afl-gcc and afl-g++ 4 years ago
gitian-building.md
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
reduce-memory.md doc: block-relay-only is not blocksonly 5 years ago
reduce-traffic.md doc: Use precise permission flags where possible 4 years ago
release-notes.md Merge #20461: rpc: Validate -rpcauth arguments 4 years ago
release-process.md Drop the leading 0 from the version number 4 years ago
shared-libraries.md
tor.md doc: Update onion service target port numbers in tor.md 4 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 doc: Adjust ZMQ usage to support multiple interfaces 4 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.