rockbox/docs
Dominik Riebeling 767672df4c Change cyrillic name in CREDITS to latin transliteration.
As discussed on IRC the cyrillic characters can cause various problems and not
all fonts include them so stick with extended latin.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30901 a1c6a512-1295-4272-9138-f99709370657
2011-11-05 10:01:53 +00:00
..
logo Move various logo files to a single location. 2011-06-04 20:31:11 +00:00
API
BATTERY-FAQ
BATTERY-FAQ-LIION
CHARGING_ALGORITHM
COMMITTERS Add me to docs/COMMITTERS 2011-11-02 13:25:05 +00:00
CONTRIBUTING
COPYING
COPYING-MANUAL
CREDITS Change cyrillic name in CREDITS to latin transliteration. 2011-11-05 10:01:53 +00:00
gpl-2.0.html Remove duplicated license file. 2010-09-04 18:50:12 +00:00
HISTORY
KNOWN_ISSUES
LICENSES
MAINTAINERS
NODO
PLUGIN_API
profontdoc.txt
README
sample.colours
sample.icons
TECH
UISIMULATOR

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

Build Your Own Rockbox

1. Check out 'rockbox' from SVN (or extract a downloaded archive).

   $ svn co svn://svn.rockbox.org/rockbox/trunk rockbox

     or

   $ tar xjf rockbox.tar.bz2

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

3. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
   that you have 'perl' in your PATH too. Your gcc cross compiler needs to be
   a particular version depending on what player you are compiling for. These
   can be acquired with the rockboxdev.sh script in the /tools/ folder of the
   source, or will have been included if you've installed one of the
   toolchains or development environments provided at http://www.rockbox.org/

   $ which sh-elf-gcc
   $ which perl

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. Run 'make' and soon the necessary pieces from the firmware and the apps
   directories have been compiled, linked and scrambled for you.

   $ make
   $ make zip

7. unzip the rockbox.zip on your music player, reboot it and
   *smile*.

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!