--- Curtis Olson wrote:
> Be aware that the master copies of all the README.xxx files come from
> the
> source tree, not the data tree. They are only replicated in the data
> tree
> for convenience.
>
> Here's my view. The README.xxx are there to collect tidbits of
> information
> not documented elsewhere or that didn't really fit elsewhere or that
> wasn't
> really formally written up in an official way. If someone were to
> update
> and move all the information from a README.xxx file over to the official
> manual, then I wouldn't have a problem with that particular README.xxx
> file
> going away.
>
> I personally would not be in favor of just dumping them all as they
> exist
> into a single large file. I like the division and the easy ability to
> edit/update them. But at some point, if something is deamed important
> enough to go into the official manual, then that's great, let's do it.
Personally, I'd prefer not to put too much developer-level content into
The FlightGear Manual (TFM). It's already pretty huge, and is really aimed
at newbie users. Hence its original title - The Gettings Started Guide.
I think most of README files are more aimed at power users, aircraft
developers and coders.
I know that the original authors of TFM envisaged a second manual aimed at
aircraft developers and coders. It sounds like this would be a good first
step towards this.
However, there are one or two hurdles I can see:-
- The README files are currently very easy for developers to edit and
update. I doubt people will be as keen to keep them up to date if they are
Latex files, especially if they need to learn a whole new set of escape
characters!
- We currently have a separate CVS Module for documentation, and
developers are even less likely to update a .tex file in another CVS
location, which may require a different reviewer/committer.
Given that the README files have fairly straightforward layout, one way
around this might be to have a script that grabs all the files for the src
module, converts them to .tex and then generates a PDF file.
Syd - you've already been through this process, do you reckon this could
be scripted into something worthwhile, or was it a pretty manual process?
-Stuart
___________________________________________________________
Yahoo! Mail is the world's favourite email. Don't settle for less, sign up for
your free account today
http://uk.rd.yahoo.com/evt=44106/*http://uk.docs.yahoo.com/mail/winter07.html
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Flightgear-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/flightgear-devel
