bitcoin/doc
fanquake 7709bf46ce
Merge bitcoin/bitcoin#22970: doc: Update snap release process for new versioning scheme
fad86061e5 doc: Update snap release process for new versioning scheme (MarcoFalke)

Pull request description:

ACKs for top commit:
  jarolrod:
    ACK fad86061e5
  fanquake:
    ACK fad86061e5 - moving these instructions to the packaging repo.

Tree-SHA512: 80a9d1484a6544e44a7e57967a62d6e3084efe946de40ac5f0ad0aeb79399d578a7b690186b33d394402d383715741203ebd09ff3f376a5f657045ed96f273e7
2021-09-16 10:41:45 +08:00
..
man
release-notes doc: Add historical release notes for 22.0 2021-09-14 13:20:48 +02:00
.gitignore
Doxyfile.in Generate doxygen documentation for test sources 2021-05-19 22:08:18 -07:00
JSON-RPC-interface.md
README.md release: remove gitian 2021-08-31 09:37:23 +08:00
README_doxygen.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md doc: update doc/benchmarking.md 2021-06-24 11:15:29 +02:00
bips.md
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 script, doc: guix touchups 2021-07-23 21:23:37 +05:30
build-osx.md
build-unix.md doc: Add packages that provide Qt Wayland plugin for Linux 2021-08-05 11:49:16 +03:00
build-windows.md doc: improve note on choosing posix mingw32 2021-05-27 19:00:34 -04:00
dependencies.md doc: document systemtap dependency 2021-07-27 16:33:43 +02:00
descriptors.md doc: mention bech32m/BIP350 in doc/descriptors.md 2021-08-30 13:45:22 -04:00
developer-notes.md doc: update enum naming in developer notes 2021-07-13 21:22:24 +02:00
dnsseed-policy.md
external-signer.md
files.md Ignore banlist.dat 2021-07-30 11:21:51 +02:00
fuzzing.md test: Update test README and lint script 2021-09-02 10:26:35 +02:00
guix.md
i2p.md Improve doc/i2p.md regarding I2P router options/versions 2021-08-19 15:41:46 +02:00
init.md
managing-wallets.md Document about wallet backup and restoration 2021-08-17 09:40:47 -03:00
multiprocess.md
productivity.md
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes.md Set regtest.BIP65Height = 111 to speed up tests 2021-08-26 11:08:24 +02:00
release-process.md doc: Update snap release process for new versioning scheme 2021-09-14 12:50:31 +02:00
shared-libraries.md
tor.md Update i2p.md and tor.md regarding -onlynet config option 2021-08-07 00:45:51 +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
zmq.md doc: Add IPv6 address to zmq example 2021-06-20 16:56:08 +02:00

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.