summaryrefslogtreecommitdiffstats
path: root/manual/getting_started/main.tex
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-03-22 13:13:52 +0000
committerMartin Arver <martin.arver@gmail.com>2006-03-22 13:13:52 +0000
commit86122ffdc3263d8f240c082c34b1f048ba170921 (patch)
treeed7f1f0936b42fbf71dd0e714471658b94f9cdc5 /manual/getting_started/main.tex
parent611e00280070d7121d024af33c349ba0e67b4639 (diff)
downloadrockbox-86122ffdc3263d8f240c082c34b1f048ba170921.tar.gz
rockbox-86122ffdc3263d8f240c082c34b1f048ba170921.tar.bz2
rockbox-86122ffdc3263d8f240c082c34b1f048ba170921.zip
Some cleanup of chapter getting started. Adds a \firmwarefilename macro to the platform files.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9183 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/getting_started/main.tex')
-rw-r--r--manual/getting_started/main.tex67
1 files changed, 13 insertions, 54 deletions
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index 2f3476f74c..ffe42eefcf 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -1,66 +1,29 @@
\chapter{Getting started}
\section{Welcome}
-This is the manual for Rockbox. Rockbox is a replacement firmware for the
-Jukebox Studio, Recorder and Ondio players made by Archos, the H120/140
-players from iRiver and the Apple iPod Nano etc. It is a complete rewrite of
-the software used to make the DAP play and record music, and contains many
-features and enhancements not available in the original firmware supplied by
-the manufacturer. Among the things that Rockbox has to offer are the
-following:
+This is the manual for Rockbox. Rockbox is an open source firmware replacement for a growing number of MP3 players. Rockbox aims to be considerably more functional and efficient than your device's stock firmware while remaining easy to use and customizable. Rockbox is written by users, for users. Not only is it free to use, it's also released under the GNU public license, which means that it will always remain free to both use and to change.
-\begin{itemize}
-\item Faster loading than the \playername\ firmware
-\item Uninterrupted playing of MP3 files {--} skipping is very rare
-\item More control over how your music is played
-\item Built in viewers for several common file types
-\item Sophisticated plugin system that allows the Jukebox to run games,
-a calendar, a clock, and many other applications.
-\item Totally removable. (Removal of Rockbox before returning the
-Jukebox for repair under warranty is advised.)
-\item Optional voice user interface for complete control without looking
-at the screen
-\end{itemize}
-Rockbox is a complete from scratch rewrite of the \playername\ software and
-uses no fragments of the original firmware. Not only is it free to
-use, it's also released under the GNU public license,
-which means that it will always remain free to both use and to change.
-
-\opt{Ondio}{Although Rockbox also runs on the Archos Ondio series of
-flash based MP3 players, this is a recent development, which is not covered
-fully in this manual. Most of this manual will, however, apply equally to
-Rockbox on the Ondio Jukeboxes. For more details on the Ondio port, please
-see the web page:
-\url{http://www.rockbox.org/twiki/bin/view/Main/ArchosOndio}.}
+Rockbox has been in development since 2001, and recieves new features, tweaks and fixes each day to provide you with the best possible experience on your MP3 player. A major goal of Rockbox is to be simple and easy to use, yet remain very customizable and configurable. We believe that you should never need to go through a series of menus for an action you perform frequently. We also believe that you should be able to configure almost anything about Rockbox you could want, pertaining to functionality. Another top priority of Rockbox is audio playback quality - Rockbox, for most models, includes a wider range of sound settings than that device's original firmware. A lot of work has been put into making Rockbox sound the best it can, and improvements are constantly being made. All models have access to a large number of plugins, including many games, applications, and graphical "demos". You can load different configurations quickly for different purposes (e.g. a large font for in your car, different sound settings for at home).Rockbox features a very wide range of languages, and all supported models also have the ability to talk to you - menus can be voiced and filenames spelled out or spoken.
\section{Getting more help}
-
-This manual is intended to be a comprehensive introduction to the Rockbox
-software. There is, however, more help available. The Rockbox website at
-\url{http://www.rockbox.org/}contains very extensive documentation and guides
-written by members of the Rockbox community and this should be your first port
-of call when looking for further help.
+This manual is intended to be a comprehensive introduction to the Rockbox software. There is, however, more help available. The Rockbox website at \url{http://www.rockbox.org/}contains very extensive documentation and guides written by members of the Rockbox community and this should be your first port of call when looking for further help.
\opt{player,recorder,recorderv2fm,ondio}{\input{getting_started/archos_choice}}
-
\section{Downloading Rockbox}
-
-The latest release of the Rockbox software will always be available from
-\url{http://www.rockbox.org/download/}.
- Windows users may wish to download the self{}-extracting Windows
-installer, which works for all Jukebox models, but those wishing to
-install manually or using a different operating system should choose
-the .zip archive containing the firmware for their model of the
-Jukebox.
+The latest release of the Rockbox software will always be available from \url{http://www.rockbox.org/download/}.
+\opt{MASCODEC}{
+Windows users may wish to download the self{}-extracting Windows installer, which works for all Jukebox models, but those wishing to install manually or using a different operating system should choose the .zip archive containing the firmware for their model of the Jukebox.
+}
\section{Installing Rockbox}
-
+\opt{MASCODEC}{
Using the Windows self installing executable to install Rockbox is the easiest
method of installing the software on your Jukebox. Simply follow the
on{}-screen instructions and select the appropriate drive letter and Jukebox
model when prompted. You can use ``Add / Remove Programs'' to uninstall the
software at a later date.
-
+}
+\textbf{INCLUDE INSTALL INSTRUCTIONS FOR IRIVERS, IPODS, IAUDIO HERE.}
For non{}-Windows users and those wishing to install manually from the archive
the procedure is still fairly simple. Connect your \playername\ to the
computer via USB as described in the manual that came with your \playername. On
@@ -69,19 +32,15 @@ Windows, the \playername\ drive will appear as a drive letter in your
its contents to your \playername\ drive. You can do this using a program such
as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
-You will need to unpack all of the files in the archive onto your hard disk. If this has been done correctly, you will have a file called \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} in the main folder of your \playername\ drive, and also a folder called /\fname{.rockbox}, which contains a number of system files used by the software.
+You will need to unpack all of the files in the archive onto your hard disk. If this has been done correctly, you will have a file called \fname{\firmwarefilename} in the main folder of your \playername\ drive, and also a folder called /\fname{.rockbox}, which contains a number of system files used by the software.
\section{Enabling Speech Support (optional)}
-
-If you wish to use speech support you will also need a language file, available from \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. For the English language, the file is called \fname{english.voice}. When it has been downloaded, unpack this file and copy it into the \fname{lang} folder which is inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on by default. See page \pageref{ref:Voiceconfiguration} for details on voice settings.
+If you wish to use speech support you will also need a language file, available from \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. For the English language, the file is called \fname{english.voice}. When it has been downloaded, unpack this file and copy it into the \fname{lang} folder which is inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on by default. See page \pageref{ref:Voiceconfiguration} for details on voice settings.
\section{Running Rockbox}
-
Remove your Jukebox from the computer's USB port. Unplug any connected power supply and turn the unit off. When you next turn the unit on, the Jukebox firmware will start to load, and then it will load Rockbox for you. When you see the Rockbox splash screen, Rockbox is loaded and ready for use.
\section{Uninstalling Rockbox}
-
If you would like to go back to using the original \playername\ software, then
-connect the \playername\ to your computer, and delete the \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} file.
-If you wish to clean up your disk, you may also wish to delete the \fname{.rockbox} folder and its contents. Turn the \playername\ off and on and the normal \playername\ software will load.
+connect the \playername\ to your computer, and delete the \fname{\firmwarefilename} file. If you wish to clean up your disk, you may also wish to delete the \fname{.rockbox} folder and its contents. Turn the \playername\ off and on and the normal \playername\ software will load.