rockbox/docs
Boris Gjenero 463c96eb77 Add myself (Boris Gjenero) to committers list
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20557 a1c6a512-1295-4272-9138-f99709370657
2009-03-27 17:32:45 +00:00
..
API
BATTERY-FAQ Convert the whole codebase to UTF-8, except docs/COMMITTERS and tools/creative.c, which need checking. 2008-05-05 10:32:46 +00:00
BATTERY-FAQ-LIION
CHARGING_ALGORITHM
COMMITTERS Add myself (Boris Gjenero) to committers list 2009-03-27 17:32:45 +00:00
CONTRIBUTING fix layout so it actually looks consistent. Nothing worse than bad looking style guides! 2009-02-12 20:49:53 +00:00
COPYING
COPYING-MANUAL
CREDITS Update german translation: go back to 'Safety' in the agc settings for now (revert half applied patch), one tweak and add the missing phrase (taken from FS#9999, add Kai Posadowsky to CREDITS for it). 2009-03-22 22:41:05 +00:00
CREDITS-MANUAL Mention the .link files as a supported file type (FS#9927) 2009-02-28 22:04:58 +00:00
CUSTOM_CFG_FORMAT
CUSTOM_WPS_FORMAT Document the database WPS tags. 2008-03-08 08:19:42 +00:00
HISTORY Convert to UTF-8 and a few tweaks. 2008-02-07 00:56:07 +00:00
KNOWN_ISSUES
LICENSES
MAINTAINERS Spanish translation update by Francisco Vila (FS#10003). Also add him as Spanish maintainer. 2009-03-11 11:05:42 +00:00
NODO
PLUGIN_API
PLUGIN_API.new Rework lcd_enabled and lcd_set/call_enable hook 2009-03-17 02:43:47 +00:00
profontdoc.txt Convert the whole codebase to UTF-8, except docs/COMMITTERS and tools/creative.c, which need checking. 2008-05-05 10:32:46 +00:00
README configure update hasn't worked in ages... 2008-01-21 22:21:28 +00:00
sample.colours Make user-visible spelling "colours" rather than "colors". 2007-06-19 04:21:06 +00:00
sample.icons Add a sample.icons file, and add a few more files to the docs folder in the zips 2007-06-18 09:32:28 +00:00
TECH Convert the whole codebase to UTF-8, except docs/COMMITTERS and tools/creative.c, which need checking. 2008-05-05 10:32:46 +00:00
UISIMULATOR FS#9808 by Ori Avtalion: Update simulator documentation with new 'simdisk' directory 2009-01-18 19:30:28 +00:00

               __________               __   ___.
     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!