Merge pull request #38 from fsb4000/guide-linux
[novacoin.git] / doc / readme-qt.rst
index b7f0d2c..34ae0a3 100644 (file)
@@ -1,38 +1,5 @@
-Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
-=================================================
-
-Features
-========
-
-- All functionality of the Wx GUI, including wallet encryption
-
-- Compatibility with Linux (both GNOME and KDE), MacOSX and Windows
-
-- Notification on incoming / outgoing transactions (compatible with FreeDesktop and other desktop notification schemes)
-
-- General interface improvements: Splash screen, tabbed interface
-
-- Overview page with current balance, unconfirmed balance, and such
-
-- Better transaction list with status icons, real-time filtering and a context menu
-
-- Asks for confirmation before sending coins, for your own safety
-
-- CSV export of transactions and address book (for Excel bookkeeping)
-
-- Shows alternative icon when connected to testnet, so you never accidentally send real coins during testing
-
-- Shows a progress bar on initial block download, so that you don't have to wonder how many blocks it needs to download to be up to date
-
-- Sendmany support, send to multiple recipients at the same time
-
-- Multiple unit support, can show subdivided bitcoins (uBTC, mBTC) for users that like large numbers
-
-- Support for English, German, Russian and Dutch languages
-
-- Address books and transaction table can be sorted by any column
-
-- Accepts "bitcoin:" URLs from browsers and other sources through drag and drop
+Novacoin-qt: Qt4 GUI for Novacoin
+===============================
 
 Build instructions
 ===================
@@ -56,9 +23,9 @@ then execute the following:
     qmake
     make
 
-Alternatively, install Qt Creator and open the `bitcoin-qt.pro` file.
+Alternatively, install Qt Creator and open the `novacoin-qt.pro` file.
 
-An executable named `bitcoin-qt` will be built.
+An executable named `novacoin-qt` will be built.
 
 
 Windows
@@ -92,7 +59,7 @@ Mac OS X
 ::
 
        sudo port selfupdate
-       sudo port install boost db48
+       sudo port install boost db48 miniupnpc
 
 - Open the .pro file in Qt Creator and build as normal (cmd-B)
 
@@ -106,7 +73,7 @@ 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:
+To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable novacoin experience), pass the following argument to qmake:
 
 ::
 
@@ -127,14 +94,6 @@ Set USE_UPNP to a different value to control this:
 | USE_UPNP=1 | build with 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
 ---------------------------------------------------
 
@@ -145,12 +104,26 @@ FreeDesktop notification interface through DBUS using the following qmake option
 
     qmake "USE_DBUS=1"
 
+Generation of QR codes
+-----------------------
+
+libqrencode may be used to generate QRCode images for payment requests. 
+It can be downloaded from http://fukuchi.org/works/qrencode/index.html.en, or installed via your package manager. Pass the USE_QRCODE 
+flag to qmake to control this:
+
++--------------+--------------------------------------------------------------------------+
+| USE_QRCODE=0 | (the default) No QRCode support - libarcode not required                 |
++--------------+--------------------------------------------------------------------------+
+| USE_QRCODE=1 | QRCode support enabled                                                   |
++--------------+--------------------------------------------------------------------------+
+
+
 Berkely DB version warning
 ==========================
 
-A warning for people using the *static binary* version of Bitcoin on a Linux/UNIX-ish system (tl;dr: **Berkely DB databases are not forward compatible**).
+A warning for people using the *static binary* version of Novacoin on a Linux/UNIX-ish system (tl;dr: **Berkely DB databases are not forward compatible**).
 
-The static binary version of Bitcoin is linked against libdb4.7 or libdb4.8 (see also `this Debian issue`_).
+The static binary version of Novacoin is linked against libdb4.8 (see also `this Debian issue`_).
 
 Now the nasty thing is that databases from 5.X are not compatible with 4.X.
 
@@ -160,3 +133,19 @@ and 4.X cannot open the new format. This means that you cannot go back to the ol
 significant hassle!
 
 .. _`this Debian issue`: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=621425
+
+Ubuntu 11.10 warning
+====================
+
+Ubuntu 11.10 has a package called 'qt-at-spi' installed by default.  At the time of writing, having that package
+installed causes novacoin-qt to crash intermittently.  The issue has been reported as `launchpad bug 857790`_, but
+isn't yet fixed.
+
+Until the bug is fixed, you can remove the qt-at-spi package to work around the problem, though this will presumably
+disable screen reader functionality for Qt apps:
+
+::
+
+    sudo apt-get remove qt-at-spi
+
+.. _`launchpad bug 857790`: https://bugs.launchpad.net/ubuntu/+source/qt-at-spi/+bug/857790