diff options
| author | Gavin Andresen <gavinandresen@gmail.com> | 2013-10-15 18:27:54 -0700 |
|---|---|---|
| committer | Gavin Andresen <gavinandresen@gmail.com> | 2013-10-15 18:27:54 -0700 |
| commit | e16c2b4422fb1d2448be0d69a887227bd6857ac0 (patch) | |
| tree | c57cc0a6a00f3aceaa28ab804e142cfabff321ef /doc | |
| parent | 5d36ff289b46b3616aaac9de76c4d3d0677be6bf (diff) | |
| parent | 0aa9851b188d5f5144debfabb249bd44ec56ea65 (diff) | |
Merge pull request #3085 from super3/master
Documentation Cleanup and Contrib Index
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/doc/README.md b/doc/README.md index 1238033fb7..378229b000 100644 --- a/doc/README.md +++ b/doc/README.md @@ -3,22 +3,15 @@ Bitcoin 0.8.2 BETA Copyright (c) 2009-2013 Bitcoin Developers +License +--------------------- 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. - -Intro ---------------------- -Bitcoin is a free open source peer-to-peer electronic cash system that is -completely decentralized, without the need for a central server or trusted -parties. Users hold the crypto keys to their own money and transact directly -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. +[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 (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. ### Unix @@ -44,10 +37,12 @@ Unpack the files into a directory and run bitcoin-qt.exe. * 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. +* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [technical support board](https://bitcointalk.org/index.php?board=4.0). Building --------------------- +The following are developer notes on how to build Bitcoin on your native platform. They are not complete guide, but include notes on the necessary libraries, compile flags, etc. + - [Bitcoin-Qt Readme](readme-qt.md) - [OSX Build Notes](build-osx.md) - [Unix Build Notes](build-unix.md) @@ -55,6 +50,8 @@ Building Development --------------------- +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. + - [Coding Guidelines](coding.md) - [Multiwallet Qt Development](multiwallet-qt.md) - [Release Notes](release-notes.md) |