summaryrefslogtreecommitdiffstats
path: root/utils/themeeditor/README
blob: adfeb7b29d95caa600511ca284d3e0b6e4d7f6d1 (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
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2010 Robert Bieber
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/

To build the theme editor, you will need a Qt development environment with the
Qt core and GUI libraries and qmake, along with standard C and C++ compilers
and libraries.  To compile, cd to the source directory and run the "qmake"
command followed by "make".  This will produce the binary "themeeditor".

The binary will launch a GUI application that will allow you to create, open,
edit and save WPS files.  Editing takes place in the central tabbed text editor.
Docks on the edges of the main window will show you a file tree, an empty
"Skin Preview," and a parse tree of the current document.  At present, only the
parse tree and the editor work correctly.  You can close all the other panels
by clicking the 'x' buttons at their corners, if you desire.  You can also
rearrange and resize panels any way you please, including tearing them off into
separate windows.

From the preferences dialog (found in the File menu, or by pressing Ctrl+P), you
can change the font and color scheme of the editor and syntax highlighter.

If you catch a bug (other than unimplemented features, which abound at this
stage) or think of a feature you'd like to see implemented, you can send me an
email at robby(at)bieberphoto(dot)com, or catch me on the #rockbox IRC channel
on Freenode.