summaryrefslogtreecommitdiff
path: root/utils/rbutilqt/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'utils/rbutilqt/INSTALL')
-rw-r--r--utils/rbutilqt/INSTALL63
1 files changed, 63 insertions, 0 deletions
diff --git a/utils/rbutilqt/INSTALL b/utils/rbutilqt/INSTALL
new file mode 100644
index 0000000000..884e7b3739
--- /dev/null
+++ b/utils/rbutilqt/INSTALL
@@ -0,0 +1,63 @@
1/***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 *
9 * All files in this archive are subject to the GNU General Public License.
10 * See the file COPYING in the source tree root for full license agreement.
11 *
12 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
13 * KIND, either express or implied.
14 *
15 ****************************************************************************/
16
17This is Rockbox Utility, the graphical installer and housekeeping utility
18for Rockbox.
19
20Requirements:
21=============
22- gcc
23- Qt 4.5.0 or later
24- at least the following folders from Rockbox svn:
25 o lib/rbcodec/codecs/libspeex
26 o rbutil/
27 o tools/
28- libusb (Linux only)
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 until
45 recent versions of Qt.
46
47Installation / Deployment:
48==========================
49Rockbox Utility is build as all-in-one binary. This means for distribution
50you need:
51- RockboxUtility (main binary)
52- rbutil_*.qm (translation files, only for non-static builds)
53You don't need any other files like configuration files, especially
54rbutil.ini which will get included into the binary.
55
56The script utils/common/deploy-rbutil.py automates building deployment
57binaries. For a complete list of paths to get from svn to build please check
58its source.
59
60
61The website for Rockbox Utility is
62http://www.rockbox.org/wiki/RockboxUtility
63