gui: Enable console line edit on setClientModel
[novacoin.git] / doc / readme-qt.rst
index 8fce96b..b2d72d8 100644 (file)
@@ -1,64 +1,65 @@
-Bitcoin-qt: Qt4 GUI for Bitcoin
+Novacoin-qt: Qt4 GUI for Novacoin
 ===============================
 
-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)
+Build instructions
+===================
 
-- General interface improvements: Splash screen, tabbed interface
+Debian
+-------
 
-- Overview page with current balance, unconfirmed balance, and such
+First, make sure that the required packages for Qt4 development of your
+distribution are installed, these are
 
-- Better transaction list with status icons, real-time filtering and a context menu
+::
 
-- Asks for confirmation before sending coins, for your own safety
+for Debian and Ubuntu  <= 11.10 :
 
-- 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
+    sudo apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
+        libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
+        libssl-dev libdb4.8++-dev
 
-- 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
+for Ubuntu >= 12.04 (please read the 'Berkely DB version warning' below):
 
-- 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
+    sudo apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
+        libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
+        libssl-dev libdb++-dev
+               
+install Git:
 
-- Support for English, German, Russian and Dutch languages
+::
 
-- Address books and transaction table can be sorted by any column
+    sudo apt-get install git
 
-- Accepts "bitcoin:" URLs from browsers and other sources through drag and drop
+clone the repository :
 
-Build instructions
-===================
+::
 
-Debian
--------
+    git clone https://github.com/novacoin-project/novacoin
+   
 
-First, make sure that the required packages for Qt4 development of your
-distribution are installed, for Debian and Ubuntu these are:
+Execute the following:
 
 ::
 
-    apt-get install qt4-qmake libqt4-dev build-essential libboost-dev libboost-system-dev \
-        libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev \
-        libssl-dev libdb4.8++-dev
+    cd novacoin
+    qmake USE_O3=1 USE_ASM=1 RELEASE=1
+    make
 
-then execute the following:
+Alternatively, install Qt Creator and open the `novacoin-qt.pro` file.
 
-::
+An executable named `novacoin-qt` will be built.
 
-    qmake
-    make
+To build novacoind execute the following:
 
-Alternatively, install Qt Creator and open the `bitcoin-qt.pro` file.
+::
 
-An executable named `bitcoin-qt` will be built.
+    cd src
+    make -f makefile.unix USE_O3=1 USE_ASM=1 STATIC=1
+    strip novacoind
 
 
 Windows
@@ -92,7 +93,7 @@ Mac OS X
 ::
 
        sudo port selfupdate
-       sudo port install boost db48 miniupnpc
+       sudo port install boost db48
 
 - Open the .pro file in Qt Creator and build as normal (cmd-B)
 
@@ -103,29 +104,41 @@ Mac OS X
 Build configuration options
 ============================
 
-UPNnP port forwarding
----------------------
+LevelDB transaction index
+--------------------------
 
-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 LevelDB for transaction index, pass the following argument to qmake:
 
 ::
 
-    qmake "USE_UPNP=1"
+    qmake "USE_LEVELDB=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**)
+No additional external dependencies are required. If you're running this on your current sources tree then don't forget to run
 
-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:
+    make distclean
+
+prior to running qmake.
+
+Assembler implementation of scrypt hashing
+------------------------------------------
+
+To use optimized scrypt implementation instead of generic scrypt module, pass the following argument to qmake:
+
+::
 
-+------------+--------------------------------------------------------------------------+
-| USE_UPNP=- | no UPnP support, miniupnpc not required;                                 |
-+------------+--------------------------------------------------------------------------+
-| USE_UPNP=0 | (the default) built with UPnP, support turned off by default at runtime; |
-+------------+--------------------------------------------------------------------------+
-| USE_UPNP=1 | build with UPnP support turned on by default at runtime.                 |
-+------------+--------------------------------------------------------------------------+
+    qmake "USE_ASM=1"
+
+
+If you're using clang compiler then you need to unroll macroses before compiling. Following commands will do this for you:
+
+::
+
+    cd src/
+    ../contrib/clang/nomacro.pl
+
+No additional external dependencies required. Note that only x86, x86_64 and ARM processors are supported.
 
 Notification support for recent (k)ubuntu versions
 ---------------------------------------------------
@@ -137,27 +150,29 @@ FreeDesktop notification interface through DBUS using the following qmake option
 
     qmake "USE_DBUS=1"
 
+Generation of QR codes
+-----------------------
+
+libqrencode is 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.
+
 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.8 (see also `this Debian issue`_).
+The static binary version of Novacoin is linked against libdb5.3.
 
-Now the nasty thing is that databases from 5.X are not compatible with 4.X.
-
-If the globally installed development package of Berkely DB installed on your system is 5.X, any source you
+If the globally installed development package of Berkely DB installed on your system is 5.X, for example, any source you
 build yourself will be linked against that. The first time you run with a 5.X version the database will be upgraded,
 and 4.X cannot open the new format. This means that you cannot go back to the old statically linked version without
 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 bitcoin-qt to crash intermittently.  The issue has been reported as `launchpad bug 857790`_, but
+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