utils/themeeditor/README

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2010 Robert Bieber
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 To build the theme editor, you will need a Qt development environment with the
  23 Qt core and GUI libraries and qmake, along with standard C and C++ compilers
  24 and libraries.  To compile, cd to the source directory and run the "qmake"
  25 command followed by "make".  This will produce the binary "themeeditor".
  26
  27 The binary will launch a GUI application that will allow you to create, open,
  28 edit and save WPS files.  Editing takes place in the central tabbed text editor.
  29 Docks on the edges of the main window will show you a file tree, an empty
  30 "Skin Preview," and a parse tree of the current document.  At present, only the
  31 parse tree and the editor work correctly.  You can close all the other panels
  32 by clicking the 'x' buttons at their corners, if you desire.  You can also
  33 rearrange and resize panels any way you please, including tearing them off into
  34 separate windows.
  35
  36 From the preferences dialog (found in the File menu, or by pressing Ctrl+P), you
  37 can change the font and color scheme of the editor and syntax highlighter.
  38
  39 If you catch a bug (other than unimplemented features, which abound at this
  40 stage) or think of a feature you'd like to see implemented, you can send me an
  41 email at robby(at)bieberphoto(dot)com, or catch me on the #rockbox IRC channel
  42 on Freenode.