History

Wladimir J. van der Laan b853746d4a Merge #15222 : docs: Add info about factors that affect dependency list `55e05a82cd` Added some factors that affect the dependency list (Martin Erlandsson) Pull request description: To simplify build instructions, the librsvg formula should be moved to the main `brew install ...` command, in my opinion. It is not a big problem to install a single extra formula, and it will only be unused for some users. An additional reason for this change is that I would like to add a comment (in a future PR) about making sure you have the latest version of all deps (in the case of preexisting formulae). That comment can be authored more clearly if this simplification PR is merged. Tree-SHA512: e63284a4e0584f071a920f6b8ac46694de38e7b1df1e0dc2b00262c1487a2f2851fae721e8f4907a4aad0335f287e881974df6f9d05fe9b26f0ba71033dce145		6 years ago
..
man	util: Add SetupHelpOptions()	6 years ago
release-notes	init: Modify docs and add release note for 12255	6 years ago
.gitignore	Ignore Doxyfile generated from Doxyfile.in template.	8 years ago
Doxyfile.in	doc: Make build system insert version in Doxyfile	8 years ago
JSON-RPC-interface.md	Doc: add information about security to the JSON-RPC doc	6 years ago
README.md	doc: Add separate productivity notes document	6 years ago
README_windows.txt	doc: Remove version numbers from READMEs	8 years ago
REST-interface.md	Address test todos by removing -txindex to nodes.	6 years ago
assets-attribution.md	[doc] Merge doc/assets-attribution.md into contrib/debian/copyright	9 years ago
benchmarking.md	trivial: Fixed typos and cleaned up language	6 years ago
bips.md	trivial: Fixed typos and cleaned up language	6 years ago
bitcoin-conf.md	Add `doc/bitcoin-conf.md`	6 years ago
bitcoin_logo_doxygen.png	Lossless image optimization	11 years ago
build-freebsd.md	doc: update FreeBSD build guide for 12.0	6 years ago
build-netbsd.md	doc: update NetBSD build instructions for 8.0	6 years ago
build-openbsd.md	Merge #14515 : doc: Update OpenBSD build guide for 6.4	6 years ago
build-osx.md	Delete README_osx.md and move its contents into build-osx.md	6 years ago
build-unix.md	Various textual improvements in build docs	6 years ago
build-windows.md	docs: add NSIS setup/install steps to windows docs	6 years ago
dependencies.md	Merge #15222 : docs: Add info about factors that affect dependency list	6 years ago
descriptors.md	Add checksums to descriptors.md	6 years ago
developer-notes.md	Merge #15348 : doc: Add separate productivity notes document	6 years ago
dnsseed-policy.md	Correct spelling mistakes in doc folder	9 years ago
files.md	Add nice table to files.md	6 years ago
fuzzing.md	qa: Add test/fuzz/test_runner.py	6 years ago
gitian-building.md	doc: move gitian building to external repo	7 years ago
init.md	init: Modify docs and add release note for 12255	6 years ago
productivity.md	doc: Add separate productivity notes document	6 years ago
psbt.md	Fix minor grammar error in doc	6 years ago
reduce-traffic.md	trivial: Fixed typos and cleaned up language	6 years ago
release-notes-14021.md	Add release notes for importing key origin info change	6 years ago
release-notes-14481.md	Add release note for listunspent P2WSH change	6 years ago
release-notes-14491.md	Add release notes for importmulti descriptor support	6 years ago
release-notes-14667.md	[rpc] util: add deriveaddresses method	6 years ago
release-notes-15226.md	[wallet] Support creating a blank wallet	6 years ago
release-notes-15393.md	Bump minimum Qt version to 5.5.1	6 years ago
release-notes.md	[rpc] mining: Omit uninitialized currentblockweight, currentblocktx	6 years ago
release-process.md	Delete README_osx.md and move its contents into build-osx.md	6 years ago
shared-libraries.md	Add NULLDUMMY verify flag in bitcoinconsensus.h	8 years ago
tor.md	Less confusing documentation for `torpassword`	6 years ago
translation_process.md	qt: Pre-0.18 split-off translations update	6 years ago
translation_strings_policy.md	A few textual improvements	6 years ago
travis-ci.md	[doc] Rework docs	8 years ago
zmq.md	ZMQ: add options to configure outbound message high water mark, aka SNDHWM	6 years ago

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.