rockbox/docs
Daniel Stenberg d2b625f818 Craig Sather's patch #749974:
Adds the ability to define 2 or more alternating lines on each line of the WPS
and the ability to control how long each alternating line is displayed before
switching to the next one.

Backward compatible with the current WPS specification language (existing WPS
files will display the same as they do now).

His HTML version of the docs is found at:

http://home.pacbell.net/csath/rockbox/details.html


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@4229 a1c6a512-1295-4272-9138-f99709370657
2004-01-14 07:59:06 +00:00
..
API initial move from other directories 2002-08-21 10:19:23 +00:00
BATTERY-FAQ Updates 2003-12-12 10:01:05 +00:00
CHARGING_ALGORITHM estimate 22 percent longer runtime when having 8 MB, assuming 192 kbps files again 2003-03-03 13:41:04 +00:00
CONTRIBUTING minor spell fix 2003-07-24 11:46:51 +00:00
COPYING Removed 'howto' addition 2003-11-20 14:13:30 +00:00
CREDITS Forgot to commit the credits 2003-11-06 00:05:16 +00:00
CUSTOM_CFG_FORMAT Added new channels modes and invert setting in cfg-loader. Patch by Christian Determann. 2003-03-10 14:07:36 +00:00
CUSTOM_WPS_FORMAT Craig Sather's patch #749974: 2004-01-14 07:59:06 +00:00
FAQ Added auto-detection of FM radio hardware 2003-12-19 02:02:24 +00:00
FILES include the history too 2003-09-07 22:44:41 +00:00
HISTORY My name is Linus Nielsen Feltzing... 2003-09-07 22:47:47 +00:00
NODO Configurable dir browser file buffer size. No more 400-file limit. No more whining. 2003-05-09 16:22:53 +00:00
README Added dependency to the tools dir, so it's automatically built with the rest. Updated build docs. 2003-07-10 11:52:42 +00:00
TECH Some more tech info 2002-10-30 23:39:37 +00:00
UISIMULATOR Updated old link. 2003-07-10 14:05:59 +00:00

               __________               __   ___.
     Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
     Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
     Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
     Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
                       \/            \/     \/    \/            \/

Build Your Own Rockbox

1. Check out 'rockbox' from CVS (or extract a downloaded archive). You
   want to check out 'rockbox-devel' instead if you want the simulator
   code too (for trying out things on host before making target tests).

   (For more information about the simulator, read UISIMULATOR.)

   $ cvs -d:pserver:anonymous@cvs.rockbox.sourceforge.net:/cvsroot/rockbox login 
   $ cvs -z3 -d:pserver:anonymous@cvs.rockbox.sourceforge.net:/cvsroot/rockbox co rockbox

     or

   $ tar xzf rockbox.tar.gz

2. Create a build directory, preferably in the same directory as the firmware/
   and apps/ directories. This is where all generated files will be written.

   $ cd rockbox
   $ mkdir build
   $ cd build

4. In your build directory, run the 'tools/configure' script and enter what
   target you want to build for and if you want a debug version or not (and a
   few more questions). It'll prompt you. The debug version is for making a
   gdb version out of it. It is only useful if you run gdb towards your target
   Archos.

   $ ../tools/configure

5. *ploink*. Now you have got a Makefile generated for you.

6. Make sure you have sh-elf-gcc and siblings in the PATH. Make sure that you
   have 'perl' in your PATH too.

   $ which sh-elf-gcc
   $ which perl

7. Run 'make' and soon the necessary pieces from the firmware and the apps
   directories have been compiled, linked and scrambled for you.

   $ make

8. Copy the archos.mod or ajbrec.ajz file to your archos, reboot it and
   *smile*.  Recent Rockbox versions need no reboots, just PLAY a new rockbox
   version and that'll be loaded and replace the currently running version.

   $ mount /dev/sda1 /mnt/archos
   $ cp ajbrec.ajz /mnt/archos
   $ umount /mnt/archos

Whenever the tools/configure script gets updated, you can make your makefile
updated too by running 'tools/configure update'.

If you want to build for more than one target, just create several build
directories and create a setup for each target:

   $ mkdir build-fmrecorder
   $ cd build-fmrecorder
   $ ../tools/configure

   $ mkdir build-player
   $ cd build-player
   $ ../tools/configure

Questions anyone? Ask on the mailing list. We'll be happy to help you!