Re: [Xenomai] Using asciidoc for README.INSTALL

[Gilles Chanteperdrix <gilles.chanteperdrix@xenomai.org>]

On 08/11/2012 10:07 AM, Philippe Gerum wrote:

> On 08/11/2012 09:46 AM, Gilles Chanteperdrix wrote:
>>
>> Hi,
>>
>> currently, the installation instructions are available on xenomai
>> website as a plain text file. It makes sense, as we want them as a plain
>> text file in the release tarball, and we do not want to maintain two
>> separate sets of installation instructions. However, a plain text file
>> is not so nice to read in a web browser.
>>
>> So, maybe we could use an asciidoc version. I tried to do a quick
>> conversion to asciidoc, and I find it looks fine:
>> http://xenomai.org/~gch/README.INSTALL.html
>> The sources however, maybe a bit less readable:
>> http://xenomai.org/~gch/README.INSTALL.txt
>> But maybe we can ask asciidoc to generate a really plain text version.
>>
>> Anyone opposed to the change?
>>
>> pros:
>> - nice online html version
>> - online one source file to maintain
>> cons:
>> - need to learn asciidoc syntax to maintain the doc
>> - a slightly less readable plain text version
> 
> That's fine, let's move to asciidoc. Those who should read the doc but 
> don't, won't notice any difference. Others are likely to know how to 
> start a browser.


README.INSTALL is the 6th most downloaded file on the web site. So,
it seems people do want to read the installation instructions in their
browser.

> I'll use the couple of brain cells I have left to learn
> a few asciidoc tags.



It is really easy, much more "plain text like" than the mediawiki markup.
Asciidoc is also able to generate man pages, so, I am going to move the
manpages we have to asciidoc, taking the opportunity to update them.
Some of our manpages are outdated, and the fact that they use the nroff
format does not make them easy to update.

-- 
                                                                Gilles.