rockbox/docs
Jonathan Gordon e900a90e11 Accept FS#6750, allow recording to start automatically (If alarm wakeup
is set to recording)


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12655 a1c6a512-1295-4272-9138-f99709370657
2007-03-07 01:59:29 +00:00
..
API Removed executable flag 2007-01-09 23:29:07 +00:00
BATTERY-FAQ
BATTERY-FAQ-LIION
CHARGING_ALGORITHM Removed executable flag 2007-01-09 23:29:07 +00:00
CONTRIBUTING git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11979 a1c6a512-1295-4272-9138-f99709370657 2007-01-10 21:25:59 +00:00
COPYING
COPYING-MANUAL Manual license is GFDL, add it to the docs folder. 2006-12-17 11:54:10 +00:00
CREDITS Accept FS#6750, allow recording to start automatically (If alarm wakeup 2007-03-07 01:59:29 +00:00
CREDITS-MANUAL Add some missing things to the X5 manual. Also updated the VU Meter screens. 2007-01-20 00:43:50 +00:00
CUSTOM_CFG_FORMAT
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
FILES Profiling support, tools and documentation. 2006-01-18 20:54:13 +00:00
HISTORY more changes 2007-01-09 19:20:07 +00:00
LICENSES Better random number generator: Mersenne twiser with improved initialisation. BSD-style license. 2006-01-20 01:21:26 +00:00
NODO
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
README modernized 2007-01-11 22:35:28 +00:00
TECH Profiling support, tools and documentation. 2006-01-18 20:54:13 +00:00
UISIMULATOR Add make install step - still quite outdated, but at least what's there is more correct now. 2005-06-26 22:47:19 +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

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. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
   that you have 'perl' in your PATH too.

   $ which sh-elf-gcc
   $ which perl

7. 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

8. 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!