diff options
Diffstat (limited to 'www')
| -rw-r--r-- | www/docs/firsttime.t | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/www/docs/firsttime.t b/www/docs/firsttime.t new file mode 100644 index 0000000000..6682a3e143 --- /dev/null +++ b/www/docs/firsttime.t | |||
| @@ -0,0 +1,67 @@ | |||
| 1 | #define _PAGE_ First Look at Rockbox | ||
| 2 | #include "head.t" | ||
| 3 | |||
| 4 | <h2>First Time Guide to Rockbox Development</h2> | ||
| 5 | <p> | ||
| 6 | Welcome to our humble project. | ||
| 7 | <p> | ||
| 8 | In order to get your hands dirty as quickly and smoothly as possible, here | ||
| 9 | follows our suggest approach! | ||
| 10 | |||
| 11 | <h2>Join the Rockbox Community</h2> | ||
| 12 | <p> | ||
| 13 | Mail: We have a very active <a href="/mail/">developers mailing list</a> no | ||
| 14 | serious Rockbox freak can live without. | ||
| 15 | <p> | ||
| 16 | IRC: There's always a bunch of friendly and helpful people around in the | ||
| 17 | <a href="/irc/">IRC channel</a>. | ||
| 18 | |||
| 19 | <h2>Setup Your Environment</h2> <p> | ||
| 20 | You need a cross-compiler and linker to build the code. Pick one of these: | ||
| 21 | <ul> | ||
| 22 | <li> | ||
| 23 | Linux (or any other unix-like OS: <a href="/cross-gcc.html">Building the cross compiler</a>. This | ||
| 24 | describes how to build and install gcc for sh1. | ||
| 25 | <li> | ||
| 26 | Windows: (the recommended way) <a href="http://rockbox.my-vserver.de/win32-sdk.html">Setup a cygwin Rockbox development environment</a> (uses approx 7.5MB) | ||
| 27 | <li> | ||
| 28 | Windows: (the other way) <a href="/sh-win/">Setting up the gnush cross compiler</a> | ||
| 29 | </ul> | ||
| 30 | |||
| 31 | <h2>Get The Source</h2> | ||
| 32 | <p> | ||
| 33 | Get a fresh source to build Rockbox from. We usually recommend you get the | ||
| 34 | sources fresh from the CVS repo (<a href="/cvs.html">How to use CVS</a>), but | ||
| 35 | you can also get a <a href="/daily.shtml">daily tarball</a> or even the <a | ||
| 36 | href="/download/">latest released source package</a>. | ||
| 37 | |||
| 38 | <h2>Build Rockbox</h2> | ||
| 39 | <p> | ||
| 40 | Build rockbox using your aquired sources! If you're using Linux or the | ||
| 41 | suggested cygwin approach, read <a href="how_to_compile.html">How to compile | ||
| 42 | Rockbox</a>. | ||
| 43 | <p> | ||
| 44 | Also note that we have put a whole lot of effort in writing simulators so | ||
| 45 | that you can build, run and try code on your host PC before you build and | ||
| 46 | download your target version. This of course requires a working compiler for | ||
| 47 | your native system. | ||
| 48 | |||
| 49 | <h2>Change Rockbox</h2> | ||
| 50 | <p> | ||
| 51 | You fixed any bugs? You added any features? Then <a href="patch.html">make a | ||
| 52 | patch</a> and head over to the <a | ||
| 53 | href="http://sourceforge.net/tracker/?group_id=44306&atid=439120">patch-tracker</a> | ||
| 54 | and submit it. Of course, you can also check the <a href="/bugs.shtml">open | ||
| 55 | bugreports</a> and jump in and fix one of them (or possibly <a | ||
| 56 | href="http://sourceforge.net/tracker/?func=add&group_id=44306&atid=439118">submit | ||
| 57 | a new bug report</a>. | ||
| 58 | |||
| 59 | <p> | ||
| 60 | Regularly checking the open <a href="/requests.shtml">feature-requests</a> | ||
| 61 | gives a picture of what people want to see happen and what is left to add... | ||
| 62 | |||
| 63 | <p> | ||
| 64 | You'll be better off with a sourceforge account for most bugreport and | ||
| 65 | feature-request work. | ||
| 66 | |||
| 67 | #include "foot.t" | ||