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
flack 58c909d8d1
Typo fix
7 years ago
..
man doc: Bump manpages to 0.15.99 7 years ago
release-notes doc: Add historical release notes for 0.15.1 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 Create dependencies.md, and link dependencies file from README & build docs 7 years ago
README_osx.md Merge #8617: Include instructions to extract Mac OS X SDK on Linux using 7zip and SleuthKit 8 years ago
README_windows.txt doc: Remove version numbers from READMEs 8 years ago
REST-interface.md Merge #10825: net: set regtest JSON-RPC port to 18443 to avoid conflict with testnet 18332 7 years ago
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 9 years ago
benchmarking.md [Doc] Add benchmarking notes 9 years ago
bips.md [Doc] Update bip.md, add support for BIP 159 7 years ago
bitcoin_logo_doxygen.png
build-openbsd.md [build] Add a script for installing db4 7 years ago
build-osx.md Docs: Bump OSX version to 10.13 in build-osx.md 7 years ago
build-unix.md [build] Add a script for installing db4 7 years ago
build-windows.md doc: Specify required source location for Windows WSL builds 7 years ago
dependencies.md [depends] ZeroMQ 4.2.2 7 years ago
developer-notes.md Typo fix 7 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
files.md qt: Backup former GUI settings on `-resetguisettings` 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 Update init.md: Fix section numbering. 7 years ago
reduce-traffic.md Remove maxuploadtargets recommended minimum 8 years ago
release-notes.md doc: Update release notes for share/rpcauth/rpcauth.py rename 7 years ago
release-process.md Add instructions for multi-processor gitian builds 7 years ago
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 8 years ago
tor.md Clarify `listenonion` 8 years ago
translation_process.md Fix typo and spelling inconsistency in CONTRIBUTING.md 8 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 Docs: Hash in ZMQ hash is raw bytes, not hex 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.