Rockbox.org home
release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Rockbox mail archive

Subject: Re: Manual

Re: Manual

From: Michael DiFebbo <medifebbo_at_rcn.com>
Date: 2006-05-25

Maxxcooldude wrote:
> "The Rockbox Manual" could (IMO) do with a the following improvement.
>
Max-

Actually, ignore my last e-mail. I'm assuming that you are looking at
the iPod or iAudio Manual. Thanks for your suggestion and offer to
help. Here's the rundown. I recently restructured parts of the
"Getting Started" chapter of the manual. As restructured, section 1.3
is essentially as you suggest:

***

1.3 Installing Rockbox

There are two separate components that need to be installed in order to
run Rockbox:
   1. The Rockbox bootloader. blah bah blah
   2. The Rockbox firmware. blah bah blah

1.3.1 Installing the Rockbox bootloader

     (detailed description)

1.3.2 Installing the Rockbox firmware.

    (detailed description)

***
We use a document system called LaTeX for the manual. If you are
interested in writing them, that would be great, and you can get more
information on this wiki page: If you are interested in writing them,
that would be great.

The main portion body of this chapter of the menu is contained in CVS in
the file manual/getting_started/main.tex. Section 1.3.1, however, is in
a separate file named manual/getting_started/platform_install.tex. The
"main.tex" file basically contains instructions that tell the compiler
building the manual, when it gets to that section, "go get this other
file and put it here."

Anyway, I wrote the bootloader install instructions for iriver
platforms, but I did not yet write the ipod_install.tex or
iaudio_install.tex files that we will need for those platforms. (If you
want to see what it will ultimately look like, check out the iriver H100
or H300 manual.) If you'd like to help, what you would need to do is to
create an ipod_install.tex file and upload it to the Flyspray patch
tracker. The best place to start would be with to take the
iriver_install.tex file and modify that as necessary to describe the
ipod installation process.

***

If this is too daunting, then recognize that we will get to these
sections in time, but that we are focusing on the iriver and archos
portions of the manual for the time being because of the pending release
for those platforms. In the meantime, I have changed the basic
structure of section 1.3 to add an "Introduction" subsection:

1.3 Installing Rockbox

1.3.1 Introduction

There are two separate components that need to be installed in order to
run Rockbox:

   1. The Rockbox bootloader. blah bah blah
   2. The Rockbox firmware. blah bah blah

1.3.2 Installing the Rockbox bootloader

     (detailed description)

1.3.3 Installing the Rockbox firmware.

    (detailed description)

***
Let me know if you think that modification makes this section more
clear. I'll check that change into CVS today and it will be reflected
in today's daily build of the manual.

Michael E. DiFebbo
_________________________________________

http://www.jumpcityjazz.com

Maxxcooldude wrote:
> "The Rockbox Manual" could (IMO) do with a the following improvement.
>
> At the moment it has:
>
> 1.3 Installing Rockbox
>
> 1 blah
> 2 blah
>
> 1.3.1 Installing the firmware
> blah blah
>
>
>
>
> I think would be clearer as;
>
> 1.3 Installing Rockbox
>
> <para para>
>
> 1.3.1 Installing the bootloader
> blah blah
>
> 1.3.2 Installing the firmware
> blah blah
>
>
> I'd be happy to do that, who do I talk to?
>
>
>
Received on Thu May 25 16:29:50 2006


Page was last modified "Jan 10 2012" The Rockbox Crew
aaa