CONSTRUCTION AREA
Go to file
Solomon Peachy bc416ff590 misc: Only include rbpaths.h and string-extra.h in places that need it
(Don't include rbpaths.h in settings.h, or string-extra.h in rbpaths.h)

Build-tested on rocker, erosq, mini2g, nano2g,
                xduoox3, clipzip, dx50, and uisim

Change-Id: If32e9c9910f5c8247a655cb64522b84d6d7ccbb5
2021-04-10 12:08:12 -04:00
android android: Fix configure script for "newer" versions of the NDK 2020-04-13 16:51:58 +02:00
apps misc: Only include rbpaths.h and string-extra.h in places that need it 2021-04-10 12:08:12 -04:00
backdrops Add Cabbiev2 port for 128x96x16 targets (Samsung YH-820), made by me. 2014-03-27 19:50:48 +00:00
bootloader MIPS: make sure to fill 'jr' branch delay slot with 'nop' 2021-04-07 19:59:57 +01:00
debian Prepare new maemo release 2013-03-10 12:12:38 +01:00
docs README: Update cross-toolchain info 2021-04-02 11:29:02 -04:00
firmware misc: Only include rbpaths.h and string-extra.h in places that need it 2021-04-10 12:08:12 -04:00
fonts Remove superfluous executable bits on a bunch of files. 2011-06-08 14:22:03 +00:00
gdb Remove the firmware decompressor and a few more other SH-stragglers. 2020-11-03 23:43:32 +00:00
icons Revert Non-Alpha Updated 8x8 tango icons 2020-10-25 16:21:58 +00:00
lib rbcodec: Fix typo in include guard 2021-04-06 17:27:06 +01:00
manual xduoox3: Global volume_limit now applies to the line output as well 2021-04-09 15:54:04 -04:00
packaging Prepare unofficial pandora release 2013-03-10 14:09:30 +01:00
rbutil rbutil: Add a new entry for the Hifiwalker H2 v1.3 variant 2021-02-05 17:27:40 +00:00
tools x1000: don't add pointless '1' after SPL signature 2021-04-09 10:53:36 +00:00
uisimulator Fix accidental fallthrough in FiiO M3K simulator keymap 2021-04-03 00:28:31 +00:00
utils New port: FiiO M3K on bare metal 2021-03-28 00:01:37 +00:00
wps New port: AIGO EROS Q / EROS K 2020-10-11 16:37:17 -04:00
.gitattributes Add a gitattributes file for the migration. 2011-12-01 14:14:59 +00:00
.gitignore New port: FiiO M3K on bare metal 2021-03-28 00:01:37 +00:00

docs/README

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

Build Your Own Rockbox

1. Clone 'rockbox' from git (or extract a downloaded archive).

   $ git clone git://git.rockbox.org/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 mips/m68k/arm-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 generated using the rockboxdev.sh script in the /tools/ folder of the
   source.

   $ which arm-elf-eabi-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-fuzeplus
   $ cd build-fuzeplus
   $ ../tools/configure

   $ mkdir build-xduoox3
   $ cd build-xduoox3
   $ ../tools/configure

Questions anyone? Ask on the mailing list or on IRC. We'll be happy to help you!