rockbox/docs
Jens Arnold 6d6392c514 Some additions & corrections
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@5175 a1c6a512-1295-4272-9138-f99709370657
2004-10-05 10:50:01 +00:00
..
API Made set_irq_level() an inline function, and optimized it by removing the bit shifts 2004-03-02 11:32:59 +00:00
BATTERY-FAQ Added comment about flashed Rockbox 2004-03-16 07:39:32 +00:00
BATTERY-FAQ-LIION Added Scott's V2/FM battery faq 2004-05-21 21:15:21 +00:00
CHARGING_ALGORITHM Brushed it up a little 2004-07-23 08:45:34 +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 .rockbox browse fixes, based on patch #861278 by Brian King: (1) Leaving the sub-browser with ON is disabled to prevent possibly endless recursion, (2) For browsing plugins and fonts, the browser doesn't quit automatically after selecting a file, for more convenient use of plugins and trying out different fonts. Additionally, the button bar display is fixed to properly reflect the unavailability of F1 in a sub-browser 2004-08-28 20:41:57 +00:00
CUSTOM_CFG_FORMAT
CUSTOM_WPS_FORMAT next-song support added to WPS, using new tags, and killed some trailing 2004-05-19 08:30:48 +00:00
FAQ Added Q80 about free disk space 2004-09-23 13:55:45 +00:00
FILES include the history too 2003-09-07 22:44:41 +00:00
HISTORY Some additions & corrections 2004-10-05 10:50:01 +00:00
NODO Slight clarification... 2004-09-17 07:16:09 +00:00
PLUGIN_API Plugin API documentation by Antoine Cellerier 2004-08-17 06:54:08 +00:00
README bad CVS info fixed now 2004-09-15 08:29:59 +00:00
TECH
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@rockbox.haxx.se:/cvsroot/rockbox login 
   $ cvs -z3 -d:pserver:anonymous@rockbox.haxx.se:/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!