summaryrefslogtreecommitdiffstats
path: root/rbutil/rbutilqt
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2010-08-30 17:52:01 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2010-08-30 17:52:01 +0000
commitb81a116f7fc77b5b67e41bb5d378c8086677e5cb (patch)
treea43e016f46ca631d129de35e0329f63d18ad95c2 /rbutil/rbutilqt
parent4756a77b47cc4a0c86315d8949468b347268c8eb (diff)
downloadrockbox-b81a116f7fc77b5b67e41bb5d378c8086677e5cb.tar.gz
rockbox-b81a116f7fc77b5b67e41bb5d378c8086677e5cb.tar.bz2
rockbox-b81a116f7fc77b5b67e41bb5d378c8086677e5cb.zip
Update INSTALL file and move it in preparation of merging rbutil/ and utils/.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27946 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'rbutil/rbutilqt')
-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 @@
+/***************************************************************************
+ * __________ __ ___.
+ * Open \______ \ ____ ____ | | _\_ |__ _______ ___
+ * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
+ * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
+ * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
+ * \/ \/ \/ \/ \/
+ * $Id$
+ *
+ * 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:
+=============
+- Qt 4.5.0 or greater
+- at least the following folders from Rockbox svn:
+ o apps/codecs/libspeex
+ o rbutil/
+ o tools/
+- libusb (Linux, Mac)
+
+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.
+
+Installation / Deployment:
+==========================
+Rockbox Utility is build as all-in-one binary. This means for distribution
+you need:
+- RockboxUtility (main binary)
+- rbutil_*.qm (translation files, optional)
+You don't need any other files like configuration files, especially
+rbutil.ini which will get included into the binary.
+
+The script deploy-release.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
+