bitcoin/doc
2018-08-02 21:27:16 +08:00
..
man doc: Update manpages to 0.16.99 2018-01-30 14:24:59 +01:00
release-notes doc: Add historical release notes for 0.16.2 2018-07-29 19:02:26 +02:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
assets-attribution.md
benchmarking.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bitcoin_logo_doxygen.png
build-freebsd.md Fix incorrect shell quoting in FreeBSD build instructions. 2018-06-15 01:34:40 -07:00
build-netbsd.md [doc] Create build-netbsd.md 2018-01-30 07:47:27 +08:00
build-openbsd.md docs: Update OpenBSD build instructions for OpenBSD 6.3 2018-05-22 06:54:40 +02:00
build-osx.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
build-unix.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
build-windows.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
dependencies.md doc: Remove mention of Qt4 from build docs 2018-06-18 12:22:14 +02:00
developer-notes.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
dnsseed-policy.md
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
files.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 2017-05-19 07:28:46 +02:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md contrib: Remove debian and rpm subfolders 2018-07-30 14:00:56 -04:00
README_osx.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
README.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
reduce-traffic.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
release-notes-pr10267.md doc: Add release notes for -includeconf 2018-05-02 14:26:46 +09:00
release-notes-pr10740.md doc: Add release notes for unloadwallet RPC 2018-06-18 16:35:17 +01:00
release-notes-pr12257.md doc: Add release notes for -avoidpartialspends 2018-07-24 15:05:38 +09:00
release-notes-pr12823.md Add config changes to release notes 2018-04-11 23:15:28 +10:00
release-notes-pr12892.md [wallet] [docs] Update release notes for removing getlabeladdress 2018-05-16 17:45:19 -04:00
release-notes-pr12924.md [docs] Add release notes for HD master key -> HD seed rename 2018-05-19 11:21:20 -04:00
release-notes-pr13033.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
release-notes.md doc: mention that macOS 10.10 is now required 2018-07-25 07:30:28 +08:00
release-process.md doc: Improve command to generate list of authors for release notes 2018-07-19 16:03:00 +10:00
REST-interface.md Fix typos and cleanup 2018-03-02 23:00:25 +02:00
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 2016-09-30 23:09:19 +08:00
tor.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
translation_process.md [docs] update transifex doc link 2018-06-02 12:26:21 +03:00
translation_strings_policy.md Docs: Modify policy to not translate command-line help 2018-07-04 09:18:29 +08:00
travis-ci.md [doc] Rework docs 2016-10-04 13:27:38 +02:00
zmq.md Fix typos and cleanup 2018-03-02 23:00:25 +02: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 is currently more than 100 GBs); 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. 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.