rockbox/docs
Peter D'Hoye aaf92393b3 Update...
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14081 a1c6a512-1295-4272-9138-f99709370657
2007-07-30 19:56:26 +00:00
..
API Removed executable flag 2007-01-09 23:29:07 +00:00
BATTERY-FAQ Added comment about flashed Rockbox 2004-03-16 07:39:32 +00:00
BATTERY-FAQ-LIION Added Scott's V2/FM battery faq 2004-05-21 21:15:21 +00:00
CHARGING_ALGORITHM Removed executable flag 2007-01-09 23:29:07 +00:00
CONTRIBUTING Probably one of the most useless commits ever: change "CVS" to "SVN". 2007-05-24 18:56:09 +00:00
COPYING Removed 'howto' addition 2003-11-20 14:13:30 +00:00
COPYING-MANUAL Manual license is GFDL, add it to the docs folder. 2006-12-17 11:54:10 +00:00
CREDITS FS7468 - updated German lang 2007-07-23 11:27:21 +00:00
CREDITS-MANUAL Ooops. Forgot to add Philippe Latulippe to the credits file. 2007-04-10 20:02:30 +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 The previous commit I did was supposed to fix the wps mode patch only 2005-08-21 20:18:24 +00:00
FAQ Updated Q76, dir buffer full 2004-12-01 08:30:25 +00:00
FILES include everything in the docs dir in tarballs 2007-07-01 08:21:58 +00:00
HISTORY more changes 2007-01-09 19:20:07 +00:00
KNOWN_ISSUES deleting files and then resume is not good 2007-05-19 16:54:25 +00:00
LICENSES Better random number generator: Mersenne twiser with improved initialisation. BSD-style license. 2006-01-20 01:21:26 +00:00
MAINTAINERS Update... 2007-07-30 19:56:26 +00:00
NODO Slight clarification... 2004-09-17 07:16:09 +00:00
PLUGIN_API Dual core support for PP502x players (iPod G4 and later, iriver h10, Sansa - iPod G3 will be coming soon.) This allows threads to be run on either core provided that all communications between the cores is done using uncached memory. There should be no significant change in battery life from doing this. Documentation (on the RockboxKernel wiki page) will follow shortly. 2007-03-04 20:06:41 +00:00
profontdoc.txt Added profont license. 2007-06-17 22:28:48 +00:00
README More modernizing, make mention that certain versions of gcc are needed. 2007-03-26 16:44:00 +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 Profiling support, tools and documentation. 2006-01-18 20:54:13 +00:00
UISIMULATOR language fix 2007-06-06 20:31:36 +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*.

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!