CONSTRUCTION AREA
Go to file
Torne Wuff 8b9d6bdd1f Add a gitattributes file for the migration.
When we start using git, we will be doing automatic line ending conversion
in a nice uniform way: everything is expected to have LFs, rather than the
current odd patchwork of svn:eol-style attributes.

This .gitattributes file configures git to normalise all line endings to LF
on checkin in files it believes are text (and its heuristics appear to be
very good). It also explicitly declares a number of file types to be binary
(which both disables line ending conversion for them and also prevents git
attempting to display a textual diff of them).

I have already normalised all files in the repository now to have the correct
line endings, so this should not do anything bad for anyone who is already
using git.



git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31104 a1c6a512-1295-4272-9138-f99709370657
2011-12-01 14:14:59 +00:00
android Android: Work around an android bug. 2011-10-22 15:28:09 +00:00
apps fuze+: update keymap and touchpad driver based on FS#12405 with minor modifications. Thanks to Jean-Louis Biasini. 2011-11-30 18:39:22 +00:00
backdrops Add missing cabbiev2 800x480 backdrop 2011-02-19 01:45:08 +00:00
bootloader Sandisk Sansa Connect port (FS #12363) 2011-11-16 14:08:01 +00:00
debian Forgot to update the short log for (unofficial) maemo build 2011-06-28 18:01:29 +00:00
docs fuze+: update keymap and touchpad driver based on FS#12405 with minor modifications. Thanks to Jean-Louis Biasini. 2011-11-30 18:39:22 +00:00
firmware Sansa Connect: Make simulator compile. UI-sansaconnect.bmp by Martin Sägmüller (based on press image). 2011-12-01 13:41:59 +00:00
flash FS#12412 : Delete old buffer allocation code which has been replaced by core_alloc, and move buffer setup code to core_alloc.c 2011-11-29 00:42:27 +00:00
fonts Remove superfluous executable bits on a bunch of files. 2011-06-08 14:22:03 +00:00
gdb Generate C file / header for svn version string 2010-05-27 09:41:46 +00:00
icons The new 12x12 iconset somehow got corrupted. Re-generate. 2011-11-26 16:16:25 +00:00
lib Use buflib for all skin engine allocations. 2011-11-15 14:11:08 +00:00
manual Rockbox does not support encrypted ADX. Clearly state this in the manual and the debug messages. 2011-11-29 20:36:11 +00:00
packaging Prepare new, unofficial pandora build 2011-06-28 17:33:04 +00:00
rbutil mkimxboot: remove an unecessary include that will prevent compilation of rbutil 2011-11-30 18:44:58 +00:00
tools Convert one more file to LF line endings. 2011-12-01 13:51:34 +00:00
uisimulator Sansa Connect: Make simulator compile. UI-sansaconnect.bmp by Martin Sägmüller (based on press image). 2011-12-01 13:41:59 +00:00
utils Convert one more file from DOS to UNIX. 2011-11-06 22:52:21 +00:00
wps lcd_color/cabbiev2: New iconset in multiple sizes 2011-11-26 16:01:11 +00:00
.gitattributes Add a gitattributes file for the migration. 2011-12-01 14:14:59 +00:00

docs/README

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