History

MarcoFalke a99999cc04 util: Add SetupHelpOptions()		2019-02-06 14:16:43 -05:00
..
man	util: Add SetupHelpOptions()	2019-02-06 14:16:43 -05:00
release-notes	init: Modify docs and add release note for 12255	2019-02-04 09:18:28 -05: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	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-conf.md	Add `doc/bitcoin-conf.md`	2018-10-19 01:13:57 +03:00
bitcoin_logo_doxygen.png	Lossless image optimization	2013-12-02 10:10:22 +01:00
build-freebsd.md	FreeBSD: Document Python 3 requirement for 'gmake check'	2018-10-31 02:52:50 -07:00
build-netbsd.md	doc: update NetBSD build instructions for 8.0	2018-12-13 12:05:45 +08:00
build-openbsd.md	Merge #14515 : doc: Update OpenBSD build guide for 6.4	2018-11-05 13:26:37 +01:00
build-osx.md	Delete README_osx.md and move its contents into build-osx.md	2019-01-21 20:24:33 +01:00
build-unix.md	Various textual improvements in build docs	2018-10-28 06:01:01 +01:00
build-windows.md	docs: add NSIS setup/install steps to windows docs	2018-12-13 22:52:17 +08:00
dependencies.md	Update zmq to 4.3.1	2019-01-18 10:25:14 +02:00
descriptors.md	A few minor formatting fixes and clarifications to descriptors.md	2018-11-22 00:21:29 -05:00
developer-notes.md	Merge #14519 : tests: add utility to easily profile node performance with perf	2019-02-05 17:40:16 -05:00
dnsseed-policy.md	Correct spelling mistakes in doc folder	2015-10-18 06:25:43 +10:00
Doxyfile.in	doc: Make build system insert version in Doxyfile	2017-04-05 09:40:56 +02:00
files.md	Add nice table to files.md	2018-12-11 22:24:09 +01:00
fuzzing.md	test: Build fuzz targets into seperate executables	2019-01-29 19:03:06 -05:00
gitian-building.md	doc: move gitian building to external repo	2017-09-25 15:45:38 +02:00
init.md	init: Modify docs and add release note for 12255	2019-02-04 09:18:28 -05:00
JSON-RPC-interface.md	Doc: add information about security to the JSON-RPC doc	2019-01-23 18:25:44 -05:00
psbt.md	Fix minor grammar error in doc	2018-12-20 21:59:56 +00:00
README.md	Merge #15132 : docs: Add FreeBSD build notes link to doc/README.md	2019-01-10 09:51:03 -05:00
README_windows.txt	doc: Remove version numbers from READMEs	2017-04-05 09:40:48 +02:00
reduce-traffic.md	trivial: Fixed typos and cleaned up language	2018-08-02 21:27:16 +08:00
release-notes-14941.md	doc: Add release notes for unloadwallet change to synchronous call	2019-01-15 00:01:00 +00:00
release-notes-14982.md	doc: Add getrpcinfo release notes	2019-01-02 12:47:32 +00:00
release-notes.md	[Docs] Small updates to getrawtransaction description	2019-02-04 08:32:08 -08:00
release-process.md	Delete README_osx.md and move its contents into build-osx.md	2019-01-21 20:24:33 +01:00
REST-interface.md	Merge #14353 : REST: add blockhash call, fetch blockhash by height	2019-01-22 19:59:02 -10:00
shared-libraries.md	Add NULLDUMMY verify flag in bitcoinconsensus.h	2016-09-30 23:09:19 +08:00
tor.md	Less confusing documentation for `torpassword`	2018-11-26 08:45:32 +08:00
translation_process.md	qt: Pre-0.18 split-off translations update	2019-02-04 15:24:37 +01: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	ZMQ: add options to configure outbound message high water mark, aka SNDHWM	2018-10-19 07:36:13 -04: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?

See the documentation at the Bitcoin Wiki for help and more information.
Ask for help on #bitcoin on Freenode. If you don't have an IRC client, use webchat here.
Ask for help on the BitcoinTalk forums, in the Technical Support board.

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

Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client, use webchat here.
Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client, use webchat here.

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.