docs/UISIMULATOR

   1                __________               __   ___.
   2      Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   3      Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   4      Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   5      Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   6                        \/            \/     \/    \/            \/
   7
   8                                How to build the UISimulators
   9
  10 Terminology
  11
  12   The hardware is mainly separated in two different versions. The "Player" is
  13   the Archos Jukebox Player 6000 and Archos Studio 20, while the "Recorder" is
  14   the Archos Recorder 20. The "Player" has a character-based LCD screen with 2
  15   lines of 11 letters and a big round thing on the keypad (featuring 6
  16   different keys), while the "Recorder" has a graphical LCD and has all its 10
  17   keys separate.
  18
  19 1. Get Sources
  20
  21   The the very latest sources off the CVS server. Get the 'tools' dir,
  22   'firmware' dir, the 'apps' dir and the 'uisimulator' dir on the same dir
  23   level, to make it easier to build things (some of the files assume this
  24   hierarchy).
  25
  26   All CVS details can be found here: http://rockbox.haxx.se/cvs.html
  27
  28 2. Build Uisimulator
  29
  30   For the X11 simulator:
  31
  32     (This has been compiled and run on at least Solaris and Linux. It should
  33     work on other unixes too but we haven't tried any other yet.)
  34
  35     Create a new directory and run the 'tools/configure' script in
  36     there. Select target to simulate and select simulation. The script will
  37     then generate a Makefile for you:
  38
  39         $ mkdir build-dir
  40         $ cd build-dir
  41         $ ../tools/configure
  42
  43         [ answer to questions ]
  44
  45         [ Makefile created, archos subdirectory created ]
  46
  47         $ make
  48         $ ./rockboxui
  49
  50     Note that the simulator uses a local subdirectory named 'archos' as "root
  51     directory" for the simulated box. Copy a bunch of mp3 files into that
  52     directory, create subdirectories and do all sorts of things you want to be
  53     able to browse when you fire up the simulator.
  54
  55
  56   For the Win32 simulator:
  57
  58     No info yet.
  59
  60 3. Run Uisimulator
  61
  62   To create a simulated disk drive for the simulator to see, create a
  63   subdirectory named 'archos' and populate it with a bunch of test
  64   files/directories.
  65
  66   Run 'rockboxui'.
  67
  68 4. Target Keypad Equivalents
  69
  70   The keyboard's numerical keypad is used to simulate the Archos keypads:
  71
  72   Keyboard   Generic Archos
  73   --------   --------------
  74   +          ON
  75   8          UP
  76   2          DOWN
  77   4          LEFT
  78   6          RIGHT
  79
  80   Keyboard   Recorder-only
  81   --------   --------------
  82   Enter      OFF
  83   5          PLAY
  84   /          F1
  85   *          F2
  86   -          F3
  87
  88   Keyboard   Player-only
  89   --------   --------------
  90   Enter      MENU
  91   6          PLAY  (there's no separation between PLAY and RIGHT)