summaryrefslogtreecommitdiffstats
path: root/rbutil/rbutilqt/INSTALL
blob: 884e7b37394a947c0e20d9e3fd590f3bccb2d6ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 *
 * All files in this archive are subject to the GNU General Public License.
 * See the file COPYING in the source tree root for full license agreement.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/

This is Rockbox Utility, the graphical installer and housekeeping utility
for Rockbox.

Requirements:
=============
- gcc
- Qt 4.5.0 or later
- at least the following folders from Rockbox svn:
  o lib/rbcodec/codecs/libspeex
  o rbutil/
  o tools/
- libusb (Linux only)

Building:
=========
- run qmake
- run make

Build Options:
==============
- static
  add "-config static" to the qmake call to build a static binary. Note that
  this also requires that you have a statically built version of Qt.
- dbg
  add "-config dbg" to build with debug symbols.
- silent
  add "-config silent" to the qmake call. This is an undocumented feature of
  Qt itself. Note that this doesn't seem to work on Windows and Mac OS X until
  recent versions of Qt.

Installation / Deployment:
==========================
Rockbox Utility is build as all-in-one binary. This means for distribution
you need:
- RockboxUtility (main binary)
- rbutil_*.qm (translation files, only for non-static builds)
You don't need any other files like configuration files, especially
rbutil.ini which will get included into the binary.

The script utils/common/deploy-rbutil.py automates building deployment
binaries. For a complete list of paths to get from svn to build please check
its source.


The website for Rockbox Utility is
http://www.rockbox.org/wiki/RockboxUtility