Gitiles
Code Review Sign In
gerrit.rockbox.org / rockbox / 4e357167b5b92bbdf152c9c04e2620c134165bc5 / . / docs / README
blob: 42339e078cf97c8e6ad939a1d28790d7029a2d9f [file] [log] [blame]
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]1 __________ __ ___.
2 Open \______ \ ____ ____ | | _\_ |__ _______ ___
3 Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
4 Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
5 Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
6 \/ \/ \/ \/ \/
7
Daniel Stenberge083a1d2003-02-20 21:01:57 +0000[diff] [blame]8Build Your Own Rockbox
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]9
Bryan Childs354c9892013-04-24 11:11:38 +0100[diff] [blame]101. Clone 'rockbox' from git (or extract a downloaded archive).
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]11
Bryan Childs354c9892013-04-24 11:11:38 +0100[diff] [blame]12 $ git clone git://git.rockbox.org/rockbox
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]13
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]14 or
15
Daniel Stenberg39d8db22007-01-11 22:35:28 +0000[diff] [blame]16 $ tar xjf rockbox.tar.bz2
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]17
182. Create a build directory, preferably in the same directory as the firmware/
19 and apps/ directories. This is where all generated files will be written.
20
21 $ cd rockbox
22 $ mkdir build
23 $ cd build
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]24
Paul Louden6c487eb2007-03-26 16:44:00 +0000[diff] [blame]253. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
26 that you have 'perl' in your PATH too. Your gcc cross compiler needs to be
27 a particular version depending on what player you are compiling for. These
28 can be acquired with the rockboxdev.sh script in the /tools/ folder of the
29 source, or will have been included if you've installed one of the
30 toolchains or development environments provided at http://www.rockbox.org/
31
32 $ which sh-elf-gcc
33 $ which perl
34
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]354. In your build directory, run the 'tools/configure' script and enter what
Daniel Stenberge083a1d2003-02-20 21:01:57 +0000[diff] [blame]36 target you want to build for and if you want a debug version or not (and a
37 few more questions). It'll prompt you. The debug version is for making a
38 gdb version out of it. It is only useful if you run gdb towards your target
39 Archos.
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]40
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]41 $ ../tools/configure
42
Daniel Stenberge083a1d2003-02-20 21:01:57 +0000[diff] [blame]435. *ploink*. Now you have got a Makefile generated for you.
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]44
Paul Louden6c487eb2007-03-26 16:44:00 +0000[diff] [blame]456. Run 'make' and soon the necessary pieces from the firmware and the apps
Daniel Stenberg5059ce52002-11-29 10:21:55 +0000[diff] [blame]46 directories have been compiled, linked and scrambled for you.
47
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]48 $ make
Daniel Stenberg39d8db22007-01-11 22:35:28 +0000[diff] [blame]49 $ make zip
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]50
Paul Louden6c487eb2007-03-26 16:44:00 +0000[diff] [blame]517. unzip the rockbox.zip on your music player, reboot it and
Daniel Stenberg39d8db22007-01-11 22:35:28 +0000[diff] [blame]52 *smile*.
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]53
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]54If you want to build for more than one target, just create several build
55directories and create a setup for each target:
Robert Hak40bafc52002-08-21 10:19:23 +0000[diff] [blame]56
Björn Stenberg4b392cd2003-07-10 11:52:42 +0000[diff] [blame]57 $ mkdir build-fmrecorder
58 $ cd build-fmrecorder
59 $ ../tools/configure
60
61 $ mkdir build-player
62 $ cd build-player
63 $ ../tools/configure
64
65Questions anyone? Ask on the mailing list. We'll be happy to help you!