bitcoin/doc
MarcoFalke 33707a2a88
Merge bitcoin/bitcoin#22782: Remove unused MaybeSetAddrName
fa9eade142 Remove GetAddrName (MarcoFalke)
fa786570a5 Remove unused RecursiveMutex cs_addrName (MarcoFalke)
fa82f4ea96 Remove unused MaybeSetAddrName (MarcoFalke)

Pull request description:

  .

ACKs for top commit:
  jnewbery:
    Code review ACK fa9eade142
  naumenkogs:
    utACK fa9eade142

Tree-SHA512: 61501a699add59225dc8127b6dfdda450d768c86f958fdf94e9c28309c3705ecfbee4b064d44228b8c1190c19c39272becc7ede8386ac1406699ea2285881c72
2021-08-27 11:46:26 +02:00
..
man
release-notes
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md doc: link to managing-wallets from doc readme 2021-08-19 08:52:25 +08:00
README_doxygen.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md
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: document systemtap dependency 2021-07-27 16:33:43 +02:00
build-windows.md
dependencies.md doc: document systemtap dependency 2021-07-27 16:33:43 +02: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
external-signer.md
files.md Ignore banlist.dat 2021-07-30 11:21:51 +02:00
fuzzing.md Document faster throughput configuration 2021-07-28 13:03:08 -07:00
gitian-building.md
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: Mention the flat directory structure for uploads 2021-08-19 16:48:39 -04: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

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.