summaryrefslogtreecommitdiff
path: root/rbutil/rbutilqt/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'rbutil/rbutilqt/INSTALL')
-rw-r--r--rbutil/rbutilqt/INSTALL61
1 files changed, 61 insertions, 0 deletions
diff --git a/rbutil/rbutilqt/INSTALL b/rbutil/rbutilqt/INSTALL
new file mode 100644
index 0000000000..a145c2cb74
--- /dev/null
+++ b/rbutil/rbutilqt/INSTALL
@@ -0,0 +1,61 @@
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
18This is Rockbox Utility, the graphical installer and housekeeping utility
19for Rockbox.
20
21Requirements:
22=============
23- Qt 4.5.0 or greater
24- at least the following folders from Rockbox svn:
25 o apps/codecs/libspeex
26 o rbutil/
27 o tools/
28- libusb (Linux, Mac)
29
30Building:
31=========
32- run qmake
33- run make
34
35Build Options:
36==============
37- static
38 add "-config static" to the qmake call to build a static binary. Note that
39 this also requires that you have a statically built version of Qt.
40- dbg
41 add "-config dbg" to build with debug symbols.
42- silent
43 add "-config silent" to the qmake call. This is an undocumented feature of
44 Qt itself. Note that this doesn't seem to work on Windows and Mac OS X.
45
46Installation / Deployment:
47==========================
48Rockbox Utility is build as all-in-one binary. This means for distribution
49you need:
50- RockboxUtility (main binary)
51- rbutil_*.qm (translation files, optional)
52You don't need any other files like configuration files, especially
53rbutil.ini which will get included into the binary.
54
55The script deploy-release.py automates building deployment binaries. For a
56complete list of paths to get from svn to build please check its source.
57
58
59The website for Rockbox Utility is
60http://www.rockbox.org/wiki/RockboxUtility
61