bitcoin/doc
MarcoFalke 19b1ceddc7
Merge #21075: doc: Fix markdown formatting
e1604b3d50 doc: Replace tabs for spaces (Gunar C. Gessner)
98db48d349 doc: Fix markdown formatting (Gunar Gessner)

Pull request description:

  Lines were being joined making it hard to read.

ACKs for top commit:
  RandyMcMillan:
    ACK e1604b3d50

Tree-SHA512: fd5a7c5e9a1cbbf0fbb13b5c30b87853c84751da7f0fad08151bda07f1933872ab51cad29a0c0a70ced48e60df6d83bff3f84c2f77d00d22723fae9a8c3534fc
2021-02-09 07:56:44 +01:00
..
man scripted-diff: Fix typo in stub manual pages 2021-01-12 16:46:55 +01:00
release-notes Fix 0.21.0 release note to specify correct option BIP 157 support 2021-01-15 14:05:59 -06:00
.gitignore
Doxyfile.in
JSON-RPC-interface.md Update 'Secure string handling' 2020-12-29 01:49:30 +05:30
README.md
README_doxygen.md
README_windows.txt
REST-interface.md rpc: Return total fee in mempool 2021-01-28 10:43:22 +01:00
assets-attribution.md
benchmarking.md
bips.md docs: mention BIPs 340-342 in doc/bips.md 2020-10-15 14:20:20 -07:00
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md doc: Update for FreeBSD 12.2, add GUI Build Instructions 2020-12-10 15:38:20 -05:00
build-netbsd.md
build-openbsd.md doc: Add bash as an OpenBSD dependency 2020-11-26 21:34:25 +01:00
build-osx.md doc: Add explicit macdeployqtplus dependencies install step 2021-01-09 09:37:12 +02:00
build-unix.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
build-windows.md
dependencies.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
descriptors.md docs: correctly identify script type 2021-02-07 12:20:01 -06:00
developer-notes.md doc: Use https URLs where possible 2021-01-04 12:23:16 +08:00
dnsseed-policy.md
files.md Merge #20152: doc: Update wallet files in files.md 2020-10-27 15:43:53 +08:00
fuzzing.md fuzz: Link all targets once 2020-12-10 07:15:42 +01:00
gitian-building.md
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 2021-01-08 11:40:01 -05:00
init.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
multiprocess.md
productivity.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-18077.md doc: Add release notes 2021-01-07 18:07:11 +02:00
release-notes-19776.md
release-notes.md Add release notes for listdescriptors RPC 2021-02-02 08:21:46 +01:00
release-process.md doc: Document use of make-tag script to make tags 2021-01-29 08:46:11 +01:00
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 2020-12-05 13:37:00 +01:00
tor.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
translation_process.md
translation_strings_policy.md
zmq.md

README.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/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-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.