bitcoin/doc
2020-03-21 19:51:31 +05:30
..
man doc: remove OpenSSL from build instructions and licensing info 2019-11-18 08:56:48 -05:00
release-notes doc: Add historical release notes for 0.19.1 2020-03-09 18:41:39 +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 [doc] fix Makefile target in benchmarking.md 2019-10-08 22:14:04 +02:00
bips.md doc: Update doc/bips.md with recent changes in master 2019-11-05 10:20:16 -05:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
bitcoin-conf.md doc: add default bitcoin.conf locations 2019-08-19 19:34:57 +02:00
build-freebsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-openbsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-osx.md Merge #18070: doc: add note about brew doctor 2020-02-20 20:56:41 +08:00
build-unix.md doc: remove Boost Chrono from install docs 2020-03-07 08:34:31 +08:00
build-windows.md doc: compiling with Visual Studio is now supported on Windows 2019-11-01 15:25:52 -04:00
dependencies.md doc: Update dependencies.md 2019-12-29 13:07:50 +02:00
descriptors.md Output a descriptor in createmultisig and addmultisigaddress 2020-01-30 23:55:36 -05:00
developer-notes.md Merge #18208: rpc: Change RPCExamples to bech32 2020-03-11 12:42:47 -04:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in test: Add crc32c exception to various linters and generation scripts 2020-01-28 17:01:48 +01:00
files.md doc: Warn about wallet.dat re-use and backups 2020-03-10 01:51:03 +08:00
fuzzing.md doc: Remove --disable-ccache from docs 2020-03-09 11:13:48 -04:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md fixing documentation to not require rpcpassword 2020-03-21 19:51:31 +05:30
JSON-RPC-interface.md doc: Clarify RPC versioning 2019-04-15 11:20:16 -04:00
productivity.md docs: Add productivity notes for "dummy rebases" 2019-05-15 14:12:45 -04:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
rapidcheck.md doc: initial RapidCheck property-based testing documentation 2019-08-19 09:18:16 +02:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
README.md doc: Change doxygen URL to doxygen.bitcoincore.org 2019-11-25 19:20:49 +01:00
reduce-memory.md use preferred shebang approach for documentation 2019-12-17 12:18:13 -05:00
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 2019-05-13 10:44:46 -04:00
release-notes.md doc: Temporary note that release notes should be edited in wiki 2020-03-19 20:57:11 +01:00
release-process.md doc: remove PPA note from release-process.md 2020-02-12 09:42:28 +08:00
REST-interface.md doc: Remove explicit network name references 2019-11-01 12:06:35 +01:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-07 21:42:32 +08:00
tor.md Elaborate on the need to re-login on Debian-based systems to use tor following usermod 2019-09-12 08:27:03 -05:00
translation_process.md build: Factor out qt translations from build system 2019-09-29 14:24:54 +02:00
translation_strings_policy.md A few textual improvements 2019-02-08 09:47:50 +01:00
zmq.md doc: Add note regarding ZMQ block notification 2019-08-19 01:05:58 +01: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/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.