From f00a0dcfed248186811ae596dbe42f83c8550b31 Mon Sep 17 00:00:00 2001 From: fanquake Date: Wed, 18 Jul 2012 22:11:56 +0800 Subject: Docs Tidy up --- doc/README | 4 ++-- doc/README_windows.txt | 2 +- doc/Tor.txt | 4 ++-- doc/assets-attribution.txt | 4 ++-- doc/build-msw.txt | 2 +- doc/build-osx.txt | 2 +- doc/build-unix.txt | 2 +- doc/readme-qt.rst | 15 ++++++++------- doc/unit-tests.txt | 2 +- 9 files changed, 19 insertions(+), 18 deletions(-) (limited to 'doc') diff --git a/doc/README b/doc/README index 4eda8bcd76..ee6478d59e 100644 --- a/doc/README +++ b/doc/README @@ -2,7 +2,7 @@ Bitcoin 0.6.99 BETA Copyright (c) 2009-2012 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying -file license.txt or http://www.opensource.org/licenses/mit-license.php. +file COPYING or 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). @@ -18,7 +18,7 @@ with each other, with the help of a P2P network to check for double-spending. Setup ----- -You need the Qt4 run-time libraries to run bitcoin-qt. On Debian or Ubuntu: +You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu: sudo apt-get install libqtgui4 Unpack the files into a directory and run: diff --git a/doc/README_windows.txt b/doc/README_windows.txt index eec252931d..dd8a62a448 100644 --- a/doc/README_windows.txt +++ b/doc/README_windows.txt @@ -2,7 +2,7 @@ Bitcoin 0.6.99 BETA Copyright (c) 2009-2012 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying -file license.txt or http://www.opensource.org/licenses/mit-license.php. +file COPYING or 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). diff --git a/doc/Tor.txt b/doc/Tor.txt index f44b016f22..8a00cd2f9d 100644 --- a/doc/Tor.txt +++ b/doc/Tor.txt @@ -36,7 +36,7 @@ outgoing connections be anonimized, but more is possible. to run a hidden service (see next section), you'll need to enable it explicitly. --connect=X When behing a Tor proxy, you can specify .onion addresses instead +-connect=X When behind a Tor proxy, you can specify .onion addresses instead -addnode=X of IP addresses or hostnames in these parameters. It requires -seednode=X SOCKS5. In Tor mode, such addresses can also be exchanged with other P2P nodes. @@ -59,7 +59,7 @@ config file): The directory can be different of course, but (both) 8333's should be equal to your bitcoind's P2P listen port (8333 by default). --externalip=X You can tell bitcoin about its publically reachable address using +-externalip=X You can tell bitcoin about its publicly reachable address using this option, and this can be a .onion address. Given the above configuration, you can find your onion address in /var/lib/tor/bitcoin-service/hostname. Onion addresses are given diff --git a/doc/assets-attribution.txt b/doc/assets-attribution.txt index 75062f7fef..4a4ab08685 100644 --- a/doc/assets-attribution.txt +++ b/doc/assets-attribution.txt @@ -26,7 +26,7 @@ Site: http://findicons.com/icon/93743/blocks_gnome_netstatus_0 Icon: src/qt/res/icons/transaction*.png Designer: md2k7 -Site: https://forum.bitcoin.org/index.php?topic=15276.0 +Site: https://bitcointalk.org/index.php?topic=15276.0 License: You are free to do with these icons as you wish, including selling, copying, modifying etc. @@ -41,7 +41,7 @@ License: LGPL Icon: src/qt/res/icons/bitcoin.png, src/qt/res/icons/toolbar.png Designer: Bitboy (optimized for 16x16 by Wladimir van der Laan) License: Public Domain -Site: http://forum.bitcoin.org/?topic=1756.0 +Site: https://bitcointalk.org/?topic=1756.0 Icon: scripts/img/reload.xcf (modified),src/qt/res/movies/update_spinner.mng Icon Pack: Kids diff --git a/doc/build-msw.txt b/doc/build-msw.txt index d4ae51d3f1..c887a7be8c 100644 --- a/doc/build-msw.txt +++ b/doc/build-msw.txt @@ -1,6 +1,6 @@ Copyright (c) 2009-2012 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying -file license.txt or http://www.opensource.org/licenses/mit-license.php. +file COPYING or 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) and UPnP diff --git a/doc/build-osx.txt b/doc/build-osx.txt index 24e825ca8c..af16162a59 100644 --- a/doc/build-osx.txt +++ b/doc/build-osx.txt @@ -1,6 +1,6 @@ Copyright (c) 2009-2012 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying -file license.txt or http://www.opensource.org/licenses/mit-license.php. +file COPYING or 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) and UPnP diff --git a/doc/build-unix.txt b/doc/build-unix.txt index 825491bba3..784d86e63d 100644 --- a/doc/build-unix.txt +++ b/doc/build-unix.txt @@ -1,6 +1,6 @@ Copyright (c) 2009-2012 Bitcoin Developers Distributed under the MIT/X11 software license, see the accompanying -file license.txt or http://www.opensource.org/licenses/mit-license.php. +file COPYING or 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) and UPnP diff --git a/doc/readme-qt.rst b/doc/readme-qt.rst index 294f31ac24..951e86f9cb 100644 --- a/doc/readme-qt.rst +++ b/doc/readme-qt.rst @@ -1,4 +1,4 @@ -Bitcoin-qt: Qt4 GUI for Bitcoin +Bitcoin-Qt: Qt4 GUI for Bitcoin =============================== Build instructions @@ -23,25 +23,26 @@ then execute the following: qmake make -Alternatively, install Qt Creator and open the `bitcoin-qt.pro` file. +Alternatively, install `Qt Creator`_ and open the `bitcoin-qt.pro` file. An executable named `bitcoin-qt` will be built. +.. _`Qt Creator`: http://qt.nokia.com/downloads/ Windows -------- Windows build instructions: -- Download the `QT Windows SDK`_ and install it. You don't need the Symbian stuff, just the desktop Qt. +- Download the `Qt Windows SDK`_ and install it. You don't need the Symbian stuff, just the desktop Qt. - Download and extract the `dependencies archive`_ [#]_, or compile openssl, boost and dbcxx yourself. - Copy the contents of the folder "deps" to "X:\\QtSDK\\mingw", replace X:\\ with the location where you installed the Qt SDK. Make sure that the contents of "deps\\include" end up in the current "include" directory. -- Open the .pro file in QT creator and build as normal (ctrl-B) +- Open the bitcoin-qt.pro file in Qt Creator and build as normal (ctrl-B) -.. _`QT Windows SDK`: http://qt.nokia.com/downloads/sdk-windows-cpp +.. _`Qt Windows SDK`: http://qt.nokia.com/downloads/sdk-windows-cpp .. _`dependencies archive`: https://download.visucore.com/bitcoin/qtgui_deps_1.zip .. [#] PGP signature: https://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_) .. _`610945D0`: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x610945D0 @@ -61,7 +62,7 @@ Mac OS X sudo port selfupdate sudo port install boost db48 miniupnpc -- Open the .pro file in Qt Creator and build as normal (cmd-B) +- Open the bitcoin-qt.pro file in Qt Creator and build as normal (cmd-B) .. _`Qt Mac OS X SDK`: http://qt.nokia.com/downloads/sdk-mac-os-cpp .. _`MacPorts`: http://www.macports.org/install.php @@ -70,7 +71,7 @@ Mac OS X Build configuration options ============================ -UPNnP port forwarding +UPnP port forwarding --------------------- To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable bitcoin experience), pass the following argument to qmake: diff --git a/doc/unit-tests.txt b/doc/unit-tests.txt index e7f215188e..f76970d51e 100644 --- a/doc/unit-tests.txt +++ b/doc/unit-tests.txt @@ -1,4 +1,4 @@ -Compiling/runing bitcoind unit tests +Compiling/running bitcoind unit tests ------------------------------------ bitcoind unit tests are in the src/test/ directory; they -- cgit v1.2.3