rockbox/docs
Daniel Stenberg cd53286f62 more heroes join the pact!
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@3885 a1c6a512-1295-4272-9138-f99709370657
2003-07-25 08:15:51 +00:00
..
API initial move from other directories 2002-08-21 10:19:23 +00:00
BATTERY-FAQ keep the lines within 80 cols 2003-06-03 08:43:53 +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 initial move from other directories 2002-08-21 10:19:23 +00:00
CREDITS more heroes join the pact! 2003-07-25 08:15:51 +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 Generalized id3v2 parsing code. Added support for the composer frame and free-form genre and tracknum frames. (Patch #706111 by Thomas Paul Diffenbach) 2003-06-04 15:09:35 +00:00
FAQ Mike Holden's corrections 2003-06-17 07:54:16 +00:00
FILES added the NODO document 2003-01-16 16:06:31 +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!