You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bitcoin/doc
MarcoFalke 3cf76c23fb
Merge #12933: doc: Refine header include policy
7 years ago
..
man doc: Update manpages to 0.16.99 7 years ago
release-notes doc: Add historical release notes for 0.16.0 7 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
README.md Add NetBSD build instruction links 7 years ago
README_osx.md Fix typos and cleanup 7 years ago
README_windows.txt doc: Remove version numbers from READMEs 8 years ago
REST-interface.md Fix typos and cleanup 7 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
benchmarking.md Updating benchmarkmarking.md with an updated sample output and help options 7 years ago
bips.md [Doc] Fix link for bip 159 pull request 7 years ago
bitcoin_logo_doxygen.png Lossless image optimization 11 years ago
build-netbsd.md [doc] Create build-netbsd.md 7 years ago
build-openbsd.md doc: Update OpenBSD build instructions for 6.2 7 years ago
build-osx.md doc: add qrencode to brew install instructions 7 years ago
build-unix.md doc: Mention configure without wallet in FreeBSD instructions 7 years ago
build-windows.md Ubuntu xenial first dependencies 7 years ago
dependencies.md Merge #12607: depends: Remove ccache 7 years ago
developer-notes.md Refine travis check for duplicate includes 7 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
files.md Update files.md for new wallets/ subdirectory 7 years ago
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 8 years ago
gitian-building.md doc: move gitian building to external repo 7 years ago
init.md docs: clarified systemd installation instructions in init.md for Ubuntu users. 7 years ago
reduce-traffic.md Remove maxuploadtargets recommended minimum 8 years ago
release-notes-pr12892.md [docs] Add release notes for wallet 'label' API. 7 years ago
release-notes.md [docs] Add release notes for wallet 'label' API. 7 years ago
release-process.md Give hint about gitian not able to download 7 years ago
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 8 years ago
tor.md doc: Use bitcoind in Tor documentation 7 years ago
translation_process.md Fix typos and cleanup 7 years ago
translation_strings_policy.md Init: Cleanup error and warning strings 9 years ago
travis-ci.md [doc] Rework docs 8 years ago
zmq.md Fix typos and cleanup 7 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 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 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.

OS X

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 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.