elements/doc
Glenn Willen 7f79f72ae9 Finish removing 'recheckpeginblockinterval'; move MainchainRPCCheck
- Finish removing all references to 'recheckpeginblockinterval', including
  documentation and tests.
- Remove periodic calls to MainchainRPCCheck; use it only at startup (and
  refactor accordingly to simplify logic.)
- Move MainchainRPCCheck from validation.h/cpp (public) to an internal
  helper function of init.cpp.
- Comment out definition of 'revalidation queue' type in txdb, to suppress
  "unused variable" warning. (Leave it visible to avoid future reuse.)
2021-09-07 15:51:34 +00:00
..
man Finish removing 'recheckpeginblockinterval'; move MainchainRPCCheck 2021-09-07 15:51:34 +00:00
release-notes doc: Remove pr release notes file in wrong dir 2019-03-05 12:52:19 +01: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 trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md Update bips.md for 0.18.0 2019-04-09 19:08:18 +08:00
bitcoin-conf.md Add doc/bitcoin-conf.md 2018-10-19 01:13:57 +03:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md doc: update FreeBSD build guide for 12.0 2019-02-15 19:54:59 +08:00
build-netbsd.md doc: update NetBSD build instructions for 8.0 2018-12-13 12:05:45 +08:00
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 2018-11-05 13:26:37 +01:00
build-osx.md Merge remote-tracking branch 'bitcoin-gh/0.18' into 0.18.0-backports 2019-06-26 11:58:58 -04:00
build-unix.md Merge remote-tracking branch 'bitcoin-gh/0.18' into 0.18.0-backports 2019-06-26 11:58:58 -04:00
build-windows.md docs: add NSIS setup/install steps to windows docs 2018-12-13 22:52:17 +08:00
dependencies.md .python-version: Bump to 3.5.6 2019-06-26 09:31:08 -04:00
descriptors.md Mention new descriptor RPCs in descriptors.md 2019-04-09 19:10:50 +08:00
developer-notes.md Merge #15348: doc: Add separate productivity notes document 2019-02-18 10:32:52 -05:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
files.md Add nice table to files.md 2018-12-11 22:24:09 +01:00
fuzzing.md qa: Add test/fuzz/test_runner.py 2019-02-13 17:12:28 -05:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md init: Modify docs and add release note for 12255 2019-02-04 09:18:28 -05:00
JSON-RPC-interface.md doc: Clarify RPC versioning 2019-04-16 08:58:38 +08:00
productivity.md doc: Add separate productivity notes document 2019-02-05 15:18:36 -05:00
psbt.md Mention new PSBT RPCs in psbt.md 2019-04-09 19:10:23 +08:00
README.md travis: Properly cache and error on timeout 2019-08-14 08:18:06 -04:00
README_windows.txt QT: Remove ^M and trailing whitespace 2019-04-10 13:22:52 -04:00
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 2019-05-16 16:15:54 -04:00
release-notes.md doc: Clean out release notes post-0.18.1 2019-08-14 13:07:59 +02:00
release-process.md doc: Update release process for snap package 2019-02-26 19:52:44 -05:00
REST-interface.md Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-09 19:09:15 +08:00
tor.md doc: describe onlynet option in doc/tor.md 2019-04-16 08:58:38 +08:00
translation_process.md qt: Pre-0.18 split-off translations update 2019-02-04 15:24:37 +01:00
translation_strings_policy.md A few textual improvements 2019-02-08 09:47:50 +01:00
zmq.md ZMQ: add options to configure outbound message high water mark, aka SNDHWM 2018-10-19 07:36:13 -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. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.