elements/doc
2026-08-10 21:02:02 +01:00
..
design Migrate elements build to Cmake 2026-03-24 11:11:11 +00:00
man generate elements man pages. Bump version to 29.4.1-rc1. Set correct copyright logic for cmake. 2026-08-10 21:02:02 +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
assets-attribution.md
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
build-freebsd.md doc: mention -DWITH_ZMQ=ON in BSD build guides 2026-05-14 14:18:01 +01:00
build-netbsd.md doc: mention -DWITH_ZMQ=ON in BSD build guides 2026-05-14 14:18:01 +01:00
build-openbsd.md doc: mention -DWITH_ZMQ=ON in BSD build guides 2026-05-14 14:18:01 +01:00
build-osx.md Merge ef380a454c into merged_master (Bitcoin PR bitcoin/bitcoin#32863) 2026-07-13 15:43:38 +00:00
build-unix.md Merge 837c5c7fd8 into merged_master (Bitcoin PR bitcoin/bitcoin#33074) 2026-07-14 11:14:25 +00: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
CMakeLists.txt cmake: add USE_SOURCE_PERMISSIONS to all configure_file usage 2024-09-06 10:52:19 +01:00
dependencies.md doc: document capnproto and libmultiprocess deps 2025-12-05 17:32:06 +00: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
Doxyfile.in build: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:35:55 +00:00
elements-block-header-format.md lint: fix codespell warnings 2023-09-27 15:56:20 +02:00
elements-confidential-transactions.md Fix linter issues 2023-08-23 09:57:01 -07:00
elements-tx-format.md lint: fix typo in tx-format doc 2022-09-07 14:44:07 +02:00
elements-upstream-tracking.md Further revisions in response to comments 2021-02-26 01:00:16 -08: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
github-merge-script.md contrib: upstream my merge-prs.sh changes 2026-02-13 16:30:02 +02: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
JSON-RPC-interface.md minor: remove unnecessary semicolons from RPC content type examples 2024-06-07 10:47:24 -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
pset.mediawiki doc: Specify flag for blinding issuances 2022-09-06 11:38:03 -04:00
README.md Merge 9909a34d79 into merged_master (Bitcoin PR bitcoin/bitcoin#30992) 2026-03-30 10:35:21 +00:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt QT: Remove ^M and trailing whitespace 2019-04-10 13:22:52 -04: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-20861.md Use Bech32m encoding for v1+ segwit addresses 2021-08-17 22:32:47 +00:00
release-notes.md doc: update release notes for v29.4rc1 2026-06-22 14:04:02 +01:00
release-process.md doc: fix transifex 404s 2025-06-19 11:48:46 +01:00
REST-interface.md doc: Fix missing comma in JSON example in REST-interface.md 2024-11-08 14:24:01 -08:00
simplicity-c-code-update.md docs: add simplicity code update instructions 2026-01-12 12:53:09 +02:00
taproot-sighash.mediawiki doc: fix SigMsg length in taproot sighash 2021-07-01 22:20:37 +00:00
tapscript_opcodes.md Remove 'pops a' duplication 2025-10-02 13:47:29 +02: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

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/elementsd (headless)
  • bin/elements-qt (GUI)

Windows

Unpack the files into a directory, and then run elements-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.