Send Coins page not cleared when changing tabs. Clear all button for clearing the...

[novacoin.git] / README.rst

diff --git a/README.rst b/README.rst
index 45fb5a3..c13134a 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,22 +1,16 @@
 Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
 =================================================
 
-**Warning** **Warning** **Warning**
+Features
+========
 
-Alpha version! I'm using this client myself on the production network, and I haven't noticed any glitches, but remember: always backup your wallet.
-Testing on the testnet is recommended.
-
-This has been implemented:
-
-- qmake / QtCreator project (.pro)
+- All functionality of the Wx GUI, including wallet encryption
 
 - Compatibility with Linux (both GNOME and KDE), MacOSX and Windows
 
-- All functionality of the original client, including taskbar icon/menu
-
-- Splash screen
+- Notification on incoming / outgoing transactions (compatible with FreeDesktop and other desktop notification schemes)
 
-- Tabbed interface
+- General interface improvements: Splash screen, tabbed interface
 
 - Overview page with current balance, unconfirmed balance, and such
 
@@ -38,13 +32,7 @@ This has been implemented:
 
 - Address books and transaction table can be sorted by any column
 
-- Accepts "bitcoin:" URLs from browsers through drag and drop
-
-This has to be done:
-
-- Start at system start
-
-- Support more languages
+- Accepts "bitcoin:" URLs from browsers and other sources through drag and drop
 
 Build instructions 
 ===================
@@ -87,10 +75,76 @@ Windows build instructions:
 - Open the .pro file in QT creator and build as normal (ctrl-B)
 
 .. _`QT Windows SDK`: http://qt.nokia.com/downloads/sdk-windows-cpp
-.. _`dependencies archive`: http://download.visucore.com/bitcoin/qtgui_deps_1.zip
-.. [#] PGP signature: http://download.visucore.com/bitcoin/qtgui_deps_1.zip.sig (signed with RSA key ID `610945D0`_)
+.. _`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
 
+
+Mac OS X
+--------
+
+- Download and install the `Qt Mac OS X SDK`_. It is recommended to also install Apple's Xcode with UNIX tools.
+
+- Download and install `MacPorts`_.
+
+- Execute the following commands in a terminal to get the dependencies:
+
+::
+
+       sudo port selfupdate
+       sudo port install boost db48
+
+- Open the .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
+
+
+Build configuration options
+============================
+
+UPNnP 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:
+
+::
+
+    qmake "USE_UPNP=1"
+
+(in **Qt Creator**, you can find the setting for additional qmake arguments under "Projects" -> "Build Settings" -> "Build Steps", then click "Details" next to **qmake**)
+
+This requires miniupnpc for UPnP port mapping.  It can be downloaded from
+http://miniupnp.tuxfamily.org/files/.  UPnP support is not compiled in by default.
+
+Set USE_UPNP to a different value to control this:
+
++------------+--------------------------------------------------------------+
+| USE_UPNP=  | (the default) no UPnP support, miniupnpc not required;       |
++------------+--------------------------------------------------------------+
+| USE_UPNP=0 | UPnP support turned off by default at runtime;               |
++------------+--------------------------------------------------------------+
+| USE_UPNP=1 | UPnP support turned on by default at runtime.                |
++------------+--------------------------------------------------------------+
+
+Mac OS X users: miniupnpc is currently outdated on MacPorts. An updated Portfile is provided in contrib/miniupnpc within this project.
+You can execute the following commands in a terminal to install it:
+
+::
+
+       cd <location of bitcoin-qt>/contrib/miniupnpc
+       sudo port install
+
+Notification support for recent (k)ubuntu versions
+---------------------------------------------------
+
+To see desktop notifications on (k)ubuntu versions starting from 10.04, enable usage of the 
+FreeDesktop notification interface through DBUS using the following qmake option:
+
+::
+
+    qmake "USE_DBUS=1"
+
 Berkely DB version warning
 ==========================