elements/doc
2023-05-11 11:26:51 +00:00
..
man Merge e7eb37128c into merged_master (Bitcoin PR #20913) 2021-06-17 20:51:51 +00:00
release-notes doc: Add historical release notes for 22.0 2021-09-14 13:20:48 +02:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md doc: update doc/benchmarking.md 2021-06-24 11:15:29 +02:00
bips.md Use Bech32m encoding for v1+ segwit addresses 2021-08-17 22:32:47 +00:00
bitcoin-conf.md doc: added info to bitcoin.conf doc 2021-07-06 09:32:37 -04:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-android.md Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
build-freebsd.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-netbsd.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-openbsd.md ci: Fix spelling to satisfy linter 2022-05-25 11:48:35 -07:00
build-osx.md lint: fix non-pylint linter errors 2021-10-15 00:20:20 +00:00
build-unix.md Merge 698b4b8fac into merged_master (Bitcoin PR bitcoin/bitcoin#22930) 2023-04-21 12:26:22 +00:00
build-windows.md doc: remove WSL install instructions and point to upstream 2021-09-17 11:24:55 +08:00
dependencies.md doc: update minimum compiler requirements for std::filesystem 2021-09-22 17:53:14 +08:00
descriptors.md doc: mention bech32m/BIP350 in doc/descriptors.md 2021-08-30 13:45:22 -04:00
developer-notes.md Merge bitcoin/bitcoin#22409: configure: keep relative paths in debug info 2021-10-11 10:34:29 +08:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in Generate doxygen documentation for test sources 2021-05-19 22:08:18 -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 Move external signer out of wallet module 2021-04-08 17:56:00 +02:00
files.md Ignore banlist.dat 2021-07-30 11:21:51 +02:00
fuzzing.md Merge bitcoin/bitcoin#22585: fuzz: add guide to fuzzing with Eclipser v1.x 2021-10-01 10:25:07 +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 Improve doc/i2p.md regarding I2P router options/versions 2021-08-19 15:41:46 +02:00
init.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
JSON-RPC-interface.md Update 'Secure string handling' 2020-12-29 01:49:30 +05:30
managing-wallets.md Document about wallet backup and restoration 2021-08-17 09:40:47 -03:00
multiprocess.md multiprocess: Add comments and documentation 2021-04-23 03:02:50 -05:00
productivity.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
pset.mediawiki doc: Specify flag for blinding issuances 2022-09-06 11:38:03 -04:00
README.md Merge 245462b66c into merged_master (Bitcoin PR bitcoin/bitcoin#22418) 2023-04-13 12:10:09 +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: update reduce-memory.md peer connections info 2021-04-17 20:17:59 +02:00
reduce-traffic.md doc: Use precise permission flags where possible 2020-07-10 15:37:42 +02:00
release-notes-20861.md Use Bech32m encoding for v1+ segwit addresses 2021-08-17 22:32:47 +00:00
release-notes-22539.md Add release notes for fee est with replacement txs 2021-09-29 17:24:30 +02:00
release-notes-23093.md Add release notes for keypool flush changes 2021-09-26 15:35:54 +13:00
release-notes.md doc: Combine 23.0 release notes 2021-10-01 09:14:42 +02:00
release-process.md doc: Update snap release process for new versioning scheme 2021-09-14 12:50:31 +02:00
REST-interface.md rpc: deprecate addresses and reqSigs from rpc outputs 2021-03-23 10:51:43 -04:00
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 2020-12-05 13:37:00 +01:00
taproot-sighash.mediawiki doc: fix SigMsg length in taproot sighash 2021-07-01 22:20:37 +00:00
tapscript_opcodes.md Fix spelling lints. 2023-02-26 19:30:18 -08:00
tor.md Merge bitcoin/bitcoin#22420: doc: Specifiy how to set the value of TORGROUP 2021-09-16 20:17:01 +02:00
tracing.md Remove GetAddrName 2021-08-26 10:44:26 +02:00
translation_process.md doc: Remove unnecessary steps from translations update process 2021-07-03 21:31:29 +02:00
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 2020-05-05 04:46:08 +03:00
zmq.md doc: Add IPv6 address to zmq example 2021-06-20 16:56:08 +02: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.