docs/UISIMULATOR

   1                __________               __   ___.
   2      Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   3      Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   4      Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   5      Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   6                        \/            \/     \/    \/            \/
   7
   8                                How to build the UISimulators
   9
  10 1. Get Sources
  11
  12   Get the very latest sources off the SVN server (or possibly get a recent
  13   source code tarball).
  14
  15   All SVN details can be found here:
  16   http://www.rockbox.org/twiki/bin/view/Main/UsingSVN
  17
  18 2. Build Uisimulator
  19
  20     Create a new directory and run the 'tools/configure' script in
  21     there. Select target to simulate and select simulation. The script will
  22     then generate a Makefile for you:
  23
  24         $ mkdir build-dir
  25         $ cd build-dir
  26         $ ../tools/configure
  27
  28         [ answer to questions ]
  29
  30         [ Makefile created, simdisk subdirectory created ]
  31
  32         $ make
  33         $ make install
  34         $ ./rockboxui
  35
  36     Note that the simulator uses a local subdirectory named 'simdisk' as "root
  37     directory" for the simulated box. Copy a bunch of mp3 files into that
  38     directory, create subdirectories and do all sorts of things you want to be
  39     able to browse when you fire up the simulator.
  40
  41 3. Run Uisimulator
  42
  43   To create a simulated disk drive for the simulator to see, create a
  44   subdirectory named 'simdisk' and populate it with a bunch of test
  45   files/directories.
  46
  47   Run 'rockboxui'.
  48
  49 4. Target Keypad Equivalents
  50
  51   The keyboard's numerical keypad is used to simulate the target keypad. See
  52   the output rockboxui displays on start for details.
  53
  54 5. Mouse Input
  55
  56   Clicking on the button images on the background will simulate pressing the
  57   appropriate buttons.  On scroll wheel targts the mouse wheel will simulate
  58   scroll wheel motion.
  59