From: Gilles Chanteperdrix <gilles.chanteperdrix@xenomai.org>
To: Xenomai <Xenomai@xenomai.org>
Subject: [Xenomai] Using asciidoc for README.INSTALL
Date: Sat, 11 Aug 2012 09:46:19 +0200 [thread overview]
Message-ID: <50260DCB.90401@xenomai.org> (raw)
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
Regards.
--
Gilles.
next reply other threads:[~2012-08-11 7:46 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-08-11 7:46 Gilles Chanteperdrix [this message]
2012-08-11 8:07 ` [Xenomai] Using asciidoc for README.INSTALL Philippe Gerum
2012-08-11 8:54 ` Gilles Chanteperdrix
2012-08-12 22:09 ` Daniele Nicolodi
2012-08-12 22:56 ` Gilles Chanteperdrix
2012-08-12 23:08 ` Daniele Nicolodi
2012-08-12 23:51 ` Gilles Chanteperdrix
2012-08-16 20:51 ` Gilles Chanteperdrix
2012-08-20 21:00 ` Gilles Chanteperdrix
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=50260DCB.90401@xenomai.org \
--to=gilles.chanteperdrix@xenomai.org \
--cc=Xenomai@xenomai.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.