aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md46
1 files changed, 35 insertions, 11 deletions
diff --git a/doc/README.md b/doc/README.md
index cdd31057ad..1238033fb7 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,10 +1,9 @@
-Bitcoin 0.8.2 BETA
+Bitcoin 0.8.2 BETA
====================
Copyright (c) 2009-2013 Bitcoin Developers
-Distributed under the MIT/X11 software license, see the accompanying
-file COPYING or http://www.opensource.org/licenses/mit-license.php.
+Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
@@ -19,8 +18,13 @@ with each other, with the help of a P2P network to check for double-spending.
Setup
---------------------
+[Bitcoin-Qt](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; 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.
+
+### Unix
+
You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:
- `sudo apt-get install libqtgui4`
+
+ sudo apt-get install libqtgui4
Unpack the files into a directory and run:
@@ -29,18 +33,38 @@ Unpack the files into a directory and run:
- bin/64/bitcoin-qt (GUI, 64-bit)
- bin/64/bitcoind (headless, 64-bit)
-See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
-for help and more information.
-Other Pages
+### Windows
+
+Unpack the files into a directory and run bitcoin-qt.exe.
+
+### Need Help?
+
+* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
+for help and more information.
+* 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).
+* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums.
+
+Building
---------------------
-- [Unix Build Notes](build-unix.md)
+- [Bitcoin-Qt Readme](readme-qt.md)
- [OSX Build Notes](build-osx.md)
+- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-msw.md)
+
+Development
+---------------------
- [Coding Guidelines](coding.md)
-- [Release Process](release-process.md)
-- [Release Notes](release-notes.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
+- [Release Notes](release-notes.md)
+- [Release Process](release-process.md)
+- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
+- [Translation Process](translation_process.md)
- [Unit Tests](unit-tests.md)
-- [Translation Process](translation_process.md) \ No newline at end of file
+
+Other Pages
+---------------------
+- [Assets Attribution](assets-attribution.md)
+- [Files](files.md)
+- [Tor Support](tor.md) \ No newline at end of file