bitcoin/doc
fanquake 084c95a18c
doc: update manual pages for v29.1
2025-09-03 13:41:57 +01:00
..
design Docs: fix typos in documentation files 2025-03-08 09:26:18 +08:00
man doc: update manual pages for v29.1 2025-09-03 13:41:57 +01:00
policy fix typos 2025-01-24 09:12:38 +08:00
release-notes doc: Archive 28.1 release notes 2025-01-13 11:52:54 -05:00
CMakeLists.txt cmake: add USE_SOURCE_PERMISSIONS to all configure_file usage 2024-09-06 10:52:19 +01:00
Doxyfile.in build: Rename `PACKAGE_*` variables to `CLIENT_*` 2024-10-28 12:35:55 +00:00
JSON-RPC-interface.md minor: remove unnecessary semicolons from RPC content type examples 2024-06-07 10:47:24 -04:00
README.md doc: update IBD requirements in doc/README.md 2024-10-02 17:46:11 +02:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
REST-interface.md doc: Fix missing comma in JSON example in REST-interface.md 2024-11-08 14:24:01 -08:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
assumeutxo.md doc: fix assumeutxo design doc link 2024-09-04 22:53:34 +01:00
benchmarking.md Merge bitcoin/bitcoin#31161: cmake: Set top-level target output locations 2025-03-12 11:19:00 +08:00
bips.md doc: taproot became always active in v24.0 2025-06-19 11:42:10 +01:00
bitcoin-conf.md doc: Add some general documentation about negated options 2025-02-13 12:30:15 -05:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
build-netbsd.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
build-openbsd.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
build-osx.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
build-unix.md doc: move `cmake -B build -LH` up in Unix build docs 2025-08-03 12:25:29 +01:00
build-windows-msvc.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
build-windows.md doc: clarify that the "-j N" goes after the "--build build" part 2025-07-03 17:42:44 +01:00
cjdns.md doc: update getnodeaddresses for CJDNS, I2P and Tor and rm link 2023-06-01 15:52:51 +02:00
dependencies.md doc: Improve dependencies documentation 2025-01-20 16:15:02 +01:00
descriptors.md tests: add functional test for miniscript decaying multisig 2025-01-22 10:21:38 -06:00
developer-notes.md Merge bitcoin/bitcoin#31161: cmake: Set top-level target output locations 2025-03-12 11:19:00 +08:00
dnsseed-policy.md Update the developer mailing list address. 2024-04-02 15:38:40 -03:00
external-signer.md wallet: compare address returned by displayaddress 2024-04-16 17:47:43 +02:00
files.md Merge bitcoin/bitcoin#29775: Testnet4 including PoW difficulty adjustment fix 2024-08-07 13:05:04 -04:00
fuzzing.md doc: Fix fuzz test_runner.py path 2025-05-06 18:04:28 +01:00
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 2021-01-08 11:40:01 -05:00
i2p.md doc: i2p: improve `-i2pacceptincoming` mention 2024-04-04 18:32:39 -03:00
init.md Merge bitcoin/bitcoin#28167: init: Add option for rpccookie permissions (replace 26088) 2024-06-27 17:35:08 -04:00
managing-wallets.md Merge bitcoin/bitcoin#27064: system: use %LOCALAPPDATA% as default datadir on windows 2024-05-23 12:11:55 -04:00
multiprocess.md Merge bitcoin/bitcoin#31161: cmake: Set top-level target output locations 2025-03-12 11:19:00 +08:00
multisig-tutorial.md scripted-diff: Adjust documentation per top-level target output location 2025-02-20 22:18:57 +00:00
offline-signing-tutorial.md scripted-diff: Adjust documentation per top-level target output location 2025-02-20 22:18:57 +00:00
p2p-bad-ports.md add more bad p2p ports 2025-07-04 16:35:35 +01:00
productivity.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
psbt.md doc: mention `descriptorprocesspsbt` in psbt.md 2024-11-12 14:56:12 +01:00
reduce-memory.md doc: Bring reduce-memory.md up to date 2025-03-04 15:37:59 +01:00
reduce-traffic.md doc: update/clarify max outbound connection count 2023-12-11 20:05:25 +01:00
release-notes.md doc: finalise release notes for 29.1 2025-09-03 13:22:28 +01:00
release-process.md doc: fix transifex 404s 2025-06-19 11:48:46 +01:00
tor.md doc: update tor docs to use bitcoind binary from path 2025-06-09 16:12:25 +01:00
tracing.md Merge bitcoin/bitcoin#31161: cmake: Set top-level target output locations 2025-03-12 11:19:00 +08:00
translation_process.md doc: fix transifex 404s 2025-06-19 11:48:46 +01:00
translation_strings_policy.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
zmq.md doc/zmq: fix unix socket path example 2025-07-28 10:28:44 +01:00

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 several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days 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.