doc/README.md

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