RE: [Avr-libc-corelib] Design Document Format (was Library DesignQuestions)

[Weddington, Eric]

> -----Original Message-----
> From: 
> address@hidden 
> [mailto:address@hidden
> gnu.org] On Behalf Of Mike Perks
> Sent: Monday, September 21, 2009 11:43 AM
> To: address@hidden
> Subject: [Avr-libc-corelib] Design Document Format (was 
> Library DesignQuestions)
> 
> Eric Weddington wrote:
> > Well this mailing list is a part of the avr-libc project on 
> Savannah. We can keep a design document on the avr-libc 
> project. However, a design document has not been started. If 
> you start one, then I would suggest doing it in a simple text 
> file, as we have Linux and FreeBSD users here so avoid any MS 
> format documents.
> >   
> How about OpenOffice saved in Microsoft Office file formats? Doesn't 
> everyone on Linux have OpenOffice by now :)
> 
> I find plain text files hard to read except for short README style 
> files. The other alternative is HTML. The possible advantage 
> of HTML is 
> that the design document can morph into the library documentation.

Well you bring up a good point: If this will eventually morph into library 
documentation, then I suggest doing it in a text file. The avr-libc project 
uses doxygen as it's documentation generation tool, and there are a number of 
independent document pages (i.e. not associated with code itself). Doxygen read 
comments in source code, so moving a text file over to doxygen is not that 
difficult.

At this point, I think content matters more than format. ;-)