elements/doc
Andrew Poelstra ba3d786a61 Merge 64194498cf into merged_master (Elements PR ElementsProject/elements#1025)
Another annoying one to deal with because it includes partial
backports. In future let's really try to stay up to date with
Core.
2021-09-05 15:42:08 +00:00
..
man Merge e7eb37128c into merged_master (Bitcoin PR #20913) 2021-06-17 20:51:51 +00:00
release-notes
.gitignore
assets-attribution.md
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
build-android.md
build-freebsd.md
build-netbsd.md
build-openbsd.md doc: recommend --disable-external-signer in OpenBSD build guide 2021-06-24 14:58:42 +02:00
build-osx.md build: set minimum supported macOS to 10.14 2021-07-11 18:43:54 +00:00
build-unix.md Merge 61fea52171 into merged_master (Bitcoin PR bitcoin/bitcoin#21942) 2021-07-10 13:37:53 +00:00
build-windows.md
dependencies.md doc: Document minimum required libc++ version 2021-06-28 05:10:56 +03:00
descriptors.md
developer-notes.md Merge bitcoin/bitcoin#18568: doc: Clarify developer notes about constant naming 2021-06-30 09:23:15 +08:00
dnsseed-policy.md
Doxyfile.in
elements-upstream-tracking.md
external-signer.md
files.md doc: fix grammar in doc/files.md 2021-06-21 15:27:57 +02:00
fuzzing.md
gitian-building.md
guix.md
i2p.md doc: mention that we enforce port=0 in I2P 2021-07-09 11:19:38 +02:00
init.md
JSON-RPC-interface.md
multiprocess.md
productivity.md
psbt.md
pset.mediawiki Mark PSET as being implemented 2021-06-22 14:42:19 -04:00
README.md Merge 8cdf91735f into merged_master (Bitcoin PR bitcoin/bitcoin#22349) 2021-07-29 06:36:50 +00:00
README_doxygen.md
README_windows.txt
reduce-memory.md
reduce-traffic.md
release-notes-20861.md Use Bech32m encoding for v1+ segwit addresses 2021-08-17 22:32:47 +00:00
release-notes.md build: set minimum supported macOS to 10.14 2021-07-11 18:43:54 +00:00
release-process.md Merge bitcoin/bitcoin#21711: guix: Add full installation and usage documentation 2021-07-20 11:09:39 +08:00
REST-interface.md
shared-libraries.md
taproot-sighash.mediawiki doc: fix SigMsg length in taproot sighash 2021-07-01 22:20:37 +00:00
tapscript_opcodes.md clarify that secp scalars are unsigned big endian 2021-08-24 10:46:33 -07:00
tor.md doc: update tor.md with removal of tor v2 support 2021-06-06 19:05:01 +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
zmq.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 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.