doc/README.md

   1 Bitcoin Core 0.12.99
   2 =====================
   3
   4 Setup
   5 ---------------------
   6 [Bitcoin Core](http://bitcoin.org/en/download) 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.
   7
   8 Running
   9 ---------------------
  10 The following are some helpful notes on how to run Bitcoin on your native platform.
  11
  12 ### Unix
  13
  14 Unpack the files into a directory and run:
  15
  16 - `bin/bitcoin-qt` (GUI) or
  17 - `bin/bitcoind` (headless)
  18
  19 ### Windows
  20
  21 Unpack the files into a directory, and then run bitcoin-qt.exe.
  22
  23 ### OS X
  24
  25 Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core.
  26
  27 ### Need Help?
  28
  29 * See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
  30 for help and more information.
  31 * Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin).
  32 * Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
  33
  34 Building
  35 ---------------------
  36 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.
  37
  38 - [OS X Build Notes](build-osx.md)
  39 - [Unix Build Notes](build-unix.md)
  40 - [Windows Build Notes](build-windows.md)
  41 - [OpenBSD Build Notes](build-openbsd.md)
  42 - [Gitian Building Guide](gitian-building.md)
  43
  44 Development
  45 ---------------------
  46 The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.
  47
  48 - [Developer Notes](developer-notes.md)
  49 - [Multiwallet Qt Development](multiwallet-qt.md)
  50 - [Release Notes](release-notes.md)
  51 - [Release Process](release-process.md)
  52 - [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
  53 - [Translation Process](translation_process.md)
  54 - [Translation Strings Policy](translation_strings_policy.md)
  55 - [Unit Tests](unit-tests.md)
  56 - [Unauthenticated REST Interface](REST-interface.md)
  57 - [Shared Libraries](shared-libraries.md)
  58 - [BIPS](bips.md)
  59 - [Dnsseed Policy](dnsseed-policy.md)
  60 - [Benchmarking](benchmarking.md)
  61
  62 ### Resources
  63 * Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
  64 * Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-core-dev).
  65 * Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-dev).
  66
  67 ### Miscellaneous
  68 - [Assets Attribution](assets-attribution.md)
  69 - [Files](files.md)
  70 - [Tor Support](tor.md)
  71 - [Init Scripts (systemd/upstart/openrc)](init.md)
  72
  73 License
  74 ---------------------
  75 Distributed under the [MIT software license](http://www.opensource.org/licenses/mit-license.php).
  76 This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
  77 cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.