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
W. J. van der Laan dcd116950f
Merge bitcoin/bitcoin#22001: doc: Generate doxygen documentation for test sources
3 years ago
..
man scripted-diff: Fix typo in stub manual pages 4 years ago
release-notes doc: Add doc/release-notes/release-notes-0.21.1.md 4 years ago
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 8 years ago
Doxyfile.in Generate doxygen documentation for test sources 4 years ago
JSON-RPC-interface.md Update 'Secure string handling' 4 years ago
README.md doc: doc/README.md IRC updates 3 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 rpc: deprecate `addresses` and `reqSigs` from rpc outputs 4 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md doc: Update bips.md for 0.21.1 4 years ago
bitcoin-conf.md doc: added info to bitcoin.conf doc 3 years ago
bitcoin_logo_doxygen.png
build-android.md Qt: add Android packaging support 4 years ago
build-freebsd.md docs: improve make with parallel jobs description. 4 years ago
build-netbsd.md docs: improve make with parallel jobs description. 4 years ago
build-openbsd.md script, doc: guix touchups 3 years ago
build-osx.md doc: note that brew installed qt is not supported 4 years ago
build-unix.md doc: document systemtap dependency 3 years ago
build-windows.md doc: improve note on choosing posix mingw32 4 years ago
dependencies.md doc: document systemtap dependency 3 years ago
descriptors.md Add tr() descriptor (derivation only, no signing) 4 years ago
developer-notes.md Merge bitcoin/bitcoin#18568: doc: Clarify developer notes about constant naming 3 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
external-signer.md Move external signer out of wallet module 4 years ago
files.md Ignore banlist.dat 3 years ago
fuzzing.md Document faster throughput configuration 3 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
i2p.md doc: add info to i2p.md about IBD time and multiple networks 3 years ago
init.md doc: Replace tabs for spaces 4 years ago
multiprocess.md multiprocess: Add comments and documentation 4 years ago
productivity.md doc: Add libnatpmp stuff 4 years ago
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 6 years ago
reduce-memory.md doc: update reduce-memory.md peer connections info 4 years ago
reduce-traffic.md doc: Use precise permission flags where possible 4 years ago
release-notes.md cli: Implement human readable -getinfo. 3 years ago
release-process.md guix, doc: Add a note that codesigners need to rebuild after tagging 3 years ago
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 4 years ago
tor.md doc: update tor.md with removal of tor v2 support 3 years ago
tracing.md tracing: Tracepoint for connected blocks 3 years ago
translation_process.md doc: Remove unnecessary steps from translations update process 3 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.