rbutil/rbutilqt/INSTALL

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * All files in this archive are subject to the GNU General Public License.
  11  * See the file COPYING in the source tree root for full license agreement.
  12  *
  13  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  14  * KIND, either express or implied.
  15  *
  16  ****************************************************************************/
  17
  18 This is Rockbox Utility, the graphical installer and housekeeping utility
  19 for Rockbox.
  20
  21 Requirements:
  22 =============
  23 - gcc
  24 - Qt 4.5.0 or later
  25 - at least the following folders from Rockbox svn:
  26   o apps/codecs/libspeex
  27   o rbutil/
  28   o tools/
  29 - libusb (Linux only)
  30
  31 Building:
  32 =========
  33 - run qmake
  34 - run make
  35
  36 Build Options:
  37 ==============
  38 - static
  39   add "-config static" to the qmake call to build a static binary. Note that
  40   this also requires that you have a statically built version of Qt.
  41 - dbg
  42   add "-config dbg" to build with debug symbols.
  43 - silent
  44   add "-config silent" to the qmake call. This is an undocumented feature of
  45   Qt itself. Note that this doesn't seem to work on Windows and Mac OS X until
  46   recent versions of Qt.
  47
  48 Installation / Deployment:
  49 ==========================
  50 Rockbox Utility is build as all-in-one binary. This means for distribution
  51 you need:
  52 - RockboxUtility (main binary)
  53 - rbutil_*.qm (translation files, only for non-static builds)
  54 You don't need any other files like configuration files, especially
  55 rbutil.ini which will get included into the binary.
  56
  57 The script utils/common/deploy-rbutil.py automates building deployment
  58 binaries. For a complete list of paths to get from svn to build please check
  59 its source.
  60
  61
  62 The website for Rockbox Utility is
  63 http://www.rockbox.org/wiki/RockboxUtility
  64