bitcoin/doc
Pieter Wuille 8332457e95
Merge pull request #7003
b8c06ef doc: Add non-style-related development guidelines (Wladimir J. van der Laan)
2015-11-28 14:15:04 +01:00
..
gitian-building Update gitian build guide for Debian 8.1 2015-09-03 15:51:37 +08:00
release-notes Add historical release notes for October 2015 bugfix releases 2015-10-14 23:14:13 +03:00
Doxyfile
README.md [doc] Users now see 'Bitcoin Core' in the OSX bundle 2015-11-17 22:21:02 +08:00
README_osx.txt Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
README_windows.txt
REST-interface.md Implement REST mempool API, add test and documentation. 2015-08-14 07:01:03 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
bips.md doc: mention BIP65 softfork in bips.md 2015-10-26 08:05:43 +01:00
bitcoin_logo_doxygen.png
build-openbsd.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
build-osx.md [doc] Remove excessive white space 2015-11-05 23:29:29 +01:00
build-unix.md [doc][trivial] Remove miniupnpc build notes build-unix 2015-11-19 09:34:08 +08:00
build-windows.md build: Improve build instructions 2015-11-04 11:57:30 +01:00
developer-notes.md doc: Add non-style-related development guidelines 2015-11-13 12:02:39 +01:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
files.md doc: update docs for Tor listening 2015-11-12 18:08:50 +01:00
gitian-building.md doc: change suite to trusty in gitian-building.md 2015-11-19 13:01:35 +01:00
init.md Merge pull request #6621 2015-10-26 17:42:00 +01:00
multiwallet-qt.md
reduce-traffic.md add documentation for exluding whitelistes peer from maxuploadtarget 2015-11-14 08:42:59 +01:00
release-notes.md Connect to Tor hidden services by default 2015-11-26 05:14:31 -05:00
release-process.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
shared-libraries.md Mention PHP bindings to libbitcoinconsensus 2015-10-18 19:04:14 +01:00
tor.md doc: update docs for Tor listening 2015-11-12 18:08:50 +01:00
translation_process.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
translation_strings_policy.md Init: Cleanup error and warning strings 2015-10-28 22:11:43 +01:00
travis-ci.txt
unit-tests.md
zmq.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00

README.md

Bitcoin Core 0.11.99

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Bitcoin transactions (which is currently several 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.

Running

The following are some helpful notes on how to run Bitcoin on your native platform.

Unix

You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:

sudo apt-get install libqtgui4

Unpack the files into a directory and run:

  • bin/32/bitcoin-qt (GUI, 32-bit) or bin/32/bitcoind (headless, 32-bit)
  • bin/64/bitcoin-qt (GUI, 64-bit) or bin/64/bitcoind (headless, 64-bit)

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.