Fix ZMQ Notification initialization and shutdown
[bitcoinplatinum.git] / doc / README.md
blob08fd724355b6099dd7747b33beadd26ea0ddf667
1 Bitcoin Core 0.11.99
2 =====================
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.
8 Running
9 ---------------------
10 The following are some helpful notes on how to run Bitcoin on your native platform.
12 ### Unix
14 You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:
16         sudo apt-get install libqtgui4
18 Unpack the files into a directory and run:
20 - bin/32/bitcoin-qt (GUI, 32-bit) or bin/32/bitcoind (headless, 32-bit)
21 - bin/64/bitcoin-qt (GUI, 64-bit) or bin/64/bitcoind (headless, 64-bit)
25 ### Windows
27 Unpack the files into a directory, and then run bitcoin-qt.exe.
29 ### OS X
31 Drag Bitcoin-Qt to your applications folder, and then run Bitcoin-Qt.
33 ### Need Help?
35 * See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
36 for help and more information.
37 * 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).
38 * Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
40 Building
41 ---------------------
42 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.
44 - [OS X Build Notes](build-osx.md)
45 - [Unix Build Notes](build-unix.md)
46 - [Gitian Building Guide](gitian-building.md)
48 Development
49 ---------------------
50 The Bitcoin repo's [root README](https://github.com/bitcoin/bitcoin/blob/master/README.md) contains relevant information on the development process and automated testing.
52 - [Developer Notes](developer-notes.md)
53 - [Multiwallet Qt Development](multiwallet-qt.md)
54 - [Release Notes](release-notes.md)
55 - [Release Process](release-process.md)
56 - [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
57 - [Translation Process](translation_process.md)
58 - [Translation Strings Policy](translation_strings_policy.md)
59 - [Unit Tests](unit-tests.md)
60 - [Unauthenticated REST Interface](REST-interface.md)
61 - [Shared Libraries](shared-libraries.md)
62 - [BIPS](bips.md)
63 - [Dnsseed Policy](dnsseed-policy.md)
65 ### Resources
66 * Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
67 * 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).
68 * 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).
70 ### Miscellaneous
71 - [Assets Attribution](assets-attribution.md)
72 - [Files](files.md)
73 - [Tor Support](tor.md)
74 - [Init Scripts (systemd/upstart/openrc)](init.md)
76 License
77 ---------------------
78 Distributed under the [MIT software license](http://www.opensource.org/licenses/mit-license.php).
79 This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
80 cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.