rockbox/docs
Björn Stenberg 42f261eebe Added new tags %pf and %pv.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@3430 a1c6a512-1295-4272-9138-f99709370657
2003-03-11 12:49:36 +00:00
..
API initial move from other directories 2002-08-21 10:19:23 +00:00
BATTERY-FAQ added 'battery level flickers\!' question 2003-01-15 14:53:15 +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 added comments 2003-03-04 15:06:53 +00:00
COPYING initial move from other directories 2002-08-21 10:19:23 +00:00
CREDITS Craig Sather shows great insight and understanding. 2003-03-05 23:03:50 +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 Added new tags %pf and %pv. 2003-03-11 12:49:36 +00:00
FAQ ispell-buffered ;-) 2003-03-05 23:23:28 +00:00
FILES added the NODO document 2003-01-16 16:06:31 +00:00
NODO typo corrections and clean ups 2003-02-21 23:40:31 +00:00
README update the CVS info to use the better modules instead 2003-02-20 21:01:57 +00:00
TECH Some more tech info 2002-10-30 23:39:37 +00:00
UISIMULATOR *** empty log message *** 2002-08-21 10:31:10 +00:00

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

Build Your Own Rockbox

1. Check out 'rockbox' from CVS (or possibly from a downloaded archive). You
   may possibly want to check out 'rockbox-devel' instead, since that includes
   the simulator code (for trying out things on host before making target
   tests).

   If you do want to play with the simulator, read UISIMULATOR.

2. Build the tools by running 'make' in the tools/ directory.

3. Create your own build directory, preferably in the same directory as the
   firmware/ and apps/ directories. This is where all generated files will be
   put.

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.

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.

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

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.

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 a new build
directory and create a setup for another target combination in there.

Questions anyone? Take them to the mailing list. We'll be happy to help you
out!