elements/doc
2025-12-04 14:58:46 +02:00
..
design doc: correct function name in AssumeUTXO design docs 2024-02-29 20:50:50 +01:00
man Fix placeholder manpages 2023-09-25 18:39:03 -07:00
policy [doc] fix docs and comments from v3 2024-02-12 14:27:25 +00:00
release-notes doc: Missing additions to 26.0 release notes 2023-12-07 15:35:44 +00:00
.gitignore
assets-attribution.md
benchmarking.md
bips.md doc: document that BIP324 on by default for v27.0 2024-02-19 15:37:59 +00:00
bitcoin-conf.md Security config warning 2022-08-19 23:18:13 -04:00
bitcoin_logo_doxygen.png
build-android.md build, qt: Use Android NDK r23 LTS 2021-12-05 03:00:02 +02:00
build-freebsd.md Merge bitcoin/bitcoin#26773: doc: FreeBSD build doc updates to reflect removal of install_db4.sh 2023-02-16 14:50:00 +00:00
build-netbsd.md doc: update for NetBSD 9.2, add GUI Build Instructions 2022-07-06 21:27:05 -04:00
build-openbsd.md doc: Update OpenBSD build docs to 7.4 2024-02-26 16:05:47 +00:00
build-osx.md Merge 1ad43f95b8 into merged_master (Bitcoin PR bitcoin/bitcoin#28881) 2025-11-10 13:46:07 +02:00
build-unix.md Merge 064919e00d into merged_master (Bitcoin PR bitcoin/bitcoin#28231) 2025-07-03 20:43:01 +02:00
build-windows.md doc: remove mingw-w64 install for "older" systems 2023-11-17 10:57:51 +00:00
cjdns.md doc: update getnodeaddresses for CJDNS, I2P and Tor and rm link 2023-06-01 15:52:51 +02:00
dependencies.md build, qt: bump Qt5 version to 5.15.3 2025-03-10 15:37:34 +00:00
descriptors.md doc: correct deriveaddresses RPC name 2022-10-30 18:11:45 +00:00
developer-notes.md doc: remove references to disable-asm option now that it's gone 2024-02-29 19:10:31 +00:00
dnsseed-policy.md
Doxyfile.in
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
external-signer.md
files.md
fuzzing.md doc: remove references to disable-asm option now that it's gone 2024-02-29 19:10:31 +00:00
guix.md
i2p.md doc: simplify the router options in doc/i2p.md 2023-06-27 10:26:57 -06:00
init.md Remove -sysperms option 2023-02-05 08:09:16 +00:00
JSON-RPC-interface.md Update JSON-RPC-interface.md 2023-08-17 13:46:18 +01:00
managing-wallets.md Change dots to an ellipsis and fix capitalization 2023-01-12 11:15:02 -05:00
multiprocess.md doc: Add multiprocess design doc 2023-12-22 16:23:33 -05:00
multisig-tutorial.md doc: update multisig-tutorial.md to default wallet type 2022-03-10 12:50:34 +01:00
offline-signing-tutorial.md Add offline signing tutorial 2023-10-27 12:32:48 +03: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: add distcc to productivity notes 2022-06-13 16:13:11 +02:00
psbt.md
pset.mediawiki doc: Specify flag for blinding issuances 2022-09-06 11:38:03 -04:00
README.md Merge 4cebad4833 into merged_master (Bitcoin PR bitcoin/bitcoin#28363) 2025-11-06 09:07:37 +02: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
release-notes-28207.md mempool: persist with XOR 2023-11-09 19:44:50 +01:00
release-notes-29189.md libconsensus: deprecate 2024-01-30 23:19:02 +00:00
release-notes-empty-template.md doc: add minimum required Linux Kernel to release-notes 2023-12-07 13:53:41 +00:00
release-process.md doc: Add link to needs-release-notes label 2023-12-07 15:56:39 +01:00
REST-interface.md Merge bitcoin/bitcoin#26207: rest: add verbose and mempool_sequence query params for mempool/contents 2023-03-15 19:39:30 -04:00
shared-libraries.md libconsensus: deprecate 2024-01-30 23:19:02 +00:00
taproot-sighash.mediawiki
tapscript_opcodes.md Remove 'pops a' duplication 2025-10-02 13:47:29 +02:00
tor.md Merge bitcoin/bitcoin#27719: doc: remove Tor link & generalize onion getnodeaddresses RPC 2023-06-01 15:24:23 +01:00
tracing.md Use int32_t type for most transaction size/weight values 2023-06-12 19:47:19 +01:00
translation_process.md doc: Update translation_process.md 2024-02-14 21:39:39 -03:00
translation_strings_policy.md
zmq.md validationinterface: only send zmq notifications for active 2023-09-30 06:38:47 -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 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/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.