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.
bitcoin/doc
laanwj fe66dad8a7
Merge bitcoin/bitcoin#24710: Add concrete steps in doc/cjdns.md to easily find a friend
3 years ago
..
man scripted-diff: Fix typo in stub manual pages 4 years ago
policy [doc] package deduplication 3 years ago
release-notes doc: Add historical release notes for 22.0 3 years ago
.gitignore
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, init: add links to doc/cjdns.md 3 years ago
README_doxygen.md
README_windows.txt
REST-interface.md transaction decoding infer output descriptors 3 years ago
assets-attribution.md
assumeutxo.md doc: add assumeutxo notes 3 years ago
benchmarking.md doc: update doc/benchmarking.md 3 years ago
bips.md doc: Mention missing BIP157 in bips.md 3 years ago
bitcoin-conf.md doc: added info to bitcoin.conf doc 3 years ago
bitcoin_logo_doxygen.png
build-android.md build, qt: Use Android NDK r23 LTS 3 years ago
build-freebsd.md doc: mention that BDB is for the legacy wallet in build-freebsd.md 3 years ago
build-netbsd.md doc: mention that BDB is for the legacy wallet in build-netbsd.md 3 years ago
build-openbsd.md doc: remove CC_FOR_BUILD from OpenBSD build doc 3 years ago
build-osx.md Merge bitcoin/bitcoin#24585: doc: mention that BDB is for the legacy wallet in build-osx.md 3 years ago
build-unix.md doc: clarify that BDB is only required for the legacy wallet 3 years ago
build-windows.md doc: Install only "-posix" MinGW compiler when possible 3 years ago
cjdns.md Add and improve informational links in doc/cjdns.md 3 years ago
dependencies.md build, qt: bump Qt5 version to 5.15.3 3 years ago
descriptors.md Merge bitcoin/bitcoin#24043: Add (sorted)multi_a descriptor for k-of-n multisig inside tr 3 years ago
developer-notes.md doc: Document clang-tidy in dev notes 3 years ago
dnsseed-policy.md
external-signer.md Move external signer out of wallet module 4 years ago
files.md Ignore banlist.dat 3 years ago
fuzzing.md fuzz: parse the command line arguments in fuzz tests 3 years ago
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 4 years ago
i2p.md doc: update i2p.md with cjdns, improve local addresses section 3 years ago
init.md doc: Replace tabs for spaces 4 years ago
managing-wallets.md Update doc to match new default wallet type 3 years ago
multiprocess.md multiprocess: Add comments and documentation 4 years ago
multisig-tutorial.md doc: update multisig-tutorial.md to default wallet type 3 years ago
p2p-bad-ports.md init, doc: improve -onlynet help and tor/i2p documentation 3 years ago
productivity.md doc: Add libnatpmp stuff 4 years ago
psbt.md doc: M-of-N multisig using descriptor wallets and PSBTs, as well as a signing flow 3 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-24118.md Add sendall RPC née sweep 3 years ago
release-notes-24198.md doc: add wtxid info in release-notes 3 years ago
release-notes-24494.md [doc] release notes for random change target 3 years ago
release-notes-empty-template.md doc: Add template for empty release notes 3 years ago
release-notes.md doc: Add template for empty release notes 3 years ago
release-process.md Merge bitcoin/bitcoin#24583: doc: Add template for empty release notes 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 cjdns and getnodeaddresses, fix tor grep, 3 years ago
tracing.md tracing: misc follow-ups to 22902 3 years ago
translation_process.md doc: Remove unnecessary steps from translations update process 3 years ago
translation_strings_policy.md
zmq.md doc: Improve ZMQ documentation 3 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.