elements/doc
2026-04-16 12:09:39 +00:00
..
design Migrate elements build to Cmake 2026-03-24 11:11:11 +00:00
man Migrate elements build to Cmake 2026-03-24 11:11:11 +00: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 [doc] Amend notes on benchmarking 2025-01-22 16:50:16 +01:00
bips.md docs: remove requirement to signal bip125 2024-10-31 13:19:31 -04: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: Install net/py-pyzmq port on FreeBSD for interface_zmq.py 2024-12-18 12:09:49 +00:00
build-netbsd.md doc: Update NetBSD Build Guide 2024-12-31 10:14:02 +00:00
build-openbsd.md doc: Install py3-zmq port on OpenBSD for interface_zmq.py 2024-12-18 19:48:03 +00:00
build-osx.md Merge cf57722788 into merged_master (Bitcoin PR bitcoin/bitcoin#31335) 2026-04-06 09:14:06 +00:00
build-unix.md Merge 5ac1e0814a into merged_master (Bitcoin PR bitcoin/bitcoin#31621) 2026-04-10 08:49:13 +00:00
build-windows-msvc.md doc: build: Fix instructions for msvc gui builds 2025-02-12 12:53:59 -08:00
build-windows.md doc: remove dependency install instructions from win docs 2024-10-16 14:47:11 +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 build, qt: bump Qt5 version to 5.15.3 2025-03-10 15:37:34 +00:00
descriptors.md tests: add functional test for miniscript decaying multisig 2025-01-22 10:21:38 -06:00
developer-notes.md doc: swap CPPFLAGS for APPEND_CPPFLAGS 2025-02-07 16:08:10 +00: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: add a section about using MSan 2025-01-22 09:47:30 -05:00
github-merge-script.md docs: add github-merge.py process for merging PRs 2026-01-23 12:09:21 +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 doc: multiprocess documentation improvements 2024-09-23 15:03:04 -05:00
multisig-tutorial.md doc: Fix grammatical errors in multisig-tutorial.md 2024-11-05 12:13:02 -08:00
offline-signing-tutorial.md doc: Add missing 'blank=true' option in offline-signing-tutorial.md 2024-11-06 10:36:30 -08:00
p2p-bad-ports.md init, doc: improve -onlynet help and tor/i2p documentation 2022-03-03 16:14:01 +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
README_windows.txt
reduce-memory.md doc: Be vague instead of wrong about MALLOC_ARENA_MAX 2023-09-20 17:12:24 +00: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-27432.md doc: add release note for #27432 (utxo-to-sqlite tool) 2025-02-16 02:24:04 +01:00
release-notes-28121.md doc: add release note about testmempoolaccept debug-message 2024-12-10 11:00:43 -05:00
release-notes-28358.md validation: drop maximum -dbcache 2024-05-28 08:36:28 +02:00
release-notes-30239.md Add release note for ephemeral dust 2024-11-12 09:41:24 -05:00
release-notes-30529.md doc: Add release notes summarizing negated option behavior changes. 2025-02-13 12:30:15 -05:00
release-notes-30592.md doc: release note for mempoolrullrbf removal 2024-10-31 13:19:31 -04:00
release-notes-30708.md rpc: add getdescriptoractivity 2024-11-26 20:47:08 -05:00
release-notes-31130.md doc: add release note for #31130 2024-10-25 09:27:30 -04:00
release-notes-31156.md doc: add release note for 31156 2024-10-28 11:38:38 -04:00
release-notes-31175.md rpc: Remove submitblock duplicate pre-check 2024-11-21 22:18:33 +01:00
release-notes-31223.md Add release note for #31223 2024-11-15 16:27:51 -05:00
release-notes-31384.md doc: add release notes 2025-02-04 11:57:56 -05:00
release-notes-31583.md doc: add release notes 2025-01-22 12:31:46 +01:00
release-notes-31600.md doc: release notes 2025-01-29 09:39:32 +01:00
release-notes-31767.md logging: Ensure -debug=0/none behaves consistently with -nodebug 2025-02-11 12:01:28 +01:00
release-notes-empty-template.md doc: Clarify min macOS and Xcode version 2025-01-06 12:30:55 +01:00
release-process.md doc: Use more precise anchor links to Xcode SDK extraction 2024-11-28 05:36:25 +00: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: remove mentions of UPnP 2024-10-25 09:27:29 -04:00
tracing.md tracing: document that peer addrs can be >68 chars 2025-02-04 10:25:39 +01:00
translation_process.md doc: update translation generation cmake example 2025-02-19 20:46:43 +01:00
translation_strings_policy.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
zmq.md doc: correct the zmq automatic build info 2024-09-25 07:07:04 -04: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.