docs/README

   1                __________               __   ___.
   2      Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   3      Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   4      Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   5      Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   6                        \/            \/     \/    \/            \/
   7
   8 Build Your Own Rockbox
   9
  10 1. Check out 'rockbox' from SVN (or extract a downloaded archive).
  11
  12    $ svn co svn://svn.rockbox.org/rockbox/trunk rockbox
  13
  14      or
  15
  16    $ tar xjf rockbox.tar.bz2
  17
  18 2. Create a build directory, preferably in the same directory as the firmware/
  19    and apps/ directories. This is where all generated files will be written.
  20
  21    $ cd rockbox
  22    $ mkdir build
  23    $ cd build
  24
  25 4. In your build directory, run the 'tools/configure' script and enter what
  26    target you want to build for and if you want a debug version or not (and a
  27    few more questions). It'll prompt you. The debug version is for making a
  28    gdb version out of it. It is only useful if you run gdb towards your target
  29    Archos.
  30
  31    $ ../tools/configure
  32
  33 5. *ploink*. Now you have got a Makefile generated for you.
  34
  35 6. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
  36    that you have 'perl' in your PATH too.
  37
  38    $ which sh-elf-gcc
  39    $ which perl
  40
  41 7. Run 'make' and soon the necessary pieces from the firmware and the apps
  42    directories have been compiled, linked and scrambled for you.
  43
  44    $ make
  45    $ make zip
  46
  47 8. unzip the rockbox.zip on your music player, reboot it and
  48    *smile*.
  49
  50 Whenever the tools/configure script gets updated, you can make your makefile
  51 updated too by running 'tools/configure update'.
  52
  53 If you want to build for more than one target, just create several build
  54 directories and create a setup for each target:
  55
  56    $ mkdir build-fmrecorder
  57    $ cd build-fmrecorder
  58    $ ../tools/configure
  59
  60    $ mkdir build-player
  61    $ cd build-player
  62    $ ../tools/configure
  63
  64 Questions anyone? Ask on the mailing list. We'll be happy to help you!