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
Wladimir J. van der Laan 1d75597ba6
Merge #10260: [doc] Minor corrections to osx dependencies
8 years ago
..
gitian-building [doc] Increase recommended memory in gitian build guide 8 years ago
man Merge #9892: Bugfix: Only install manpages for built programs 8 years ago
release-notes doc: Add historical release notes for 0.14.1 8 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 doc: Remove version numbers from READMEs 8 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 Add default port numbers to REST doc 8 years ago
assets-attribution.md
benchmarking.md [Doc] Add benchmarking notes 9 years ago
bips.md [doc] Update doc/bips.md for BIP90 implementation 8 years ago
bitcoin_logo_doxygen.png
build-openbsd.md Update OpenBSD and FreeBSD build steps 8 years ago
build-osx.md [doc] Minor corrections to osx dependencies 8 years ago
build-unix.md Minor fix in build documentation for FreeBSD 11 8 years ago
build-windows.md Update the Windows build notes 8 years ago
developer-notes.md doc: Add RPC interface guidelines 8 years ago
dnsseed-policy.md Correct spelling mistakes in doc folder 9 years ago
files.md Add mempool.dat to doc/files.md 8 years ago
fuzzing.md doc: Add bare-bones documentation for fuzzing 8 years ago
gitian-building.md fix gitian doc example typo 8 years ago
init.md Merge pull request #6621 9 years ago
reduce-traffic.md Remove maxuploadtargets recommended minimum 8 years ago
release-notes.md Update release notes to include RPC error code changes. 8 years ago
release-process.md doc: Update release process for simplified version bumping 8 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 Fix typo and spelling inconsistency in CONTRIBUTING.md 8 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.