Hi,
as we have agreed on last meeting, I have started rewriting READMEs so
that
* they employ consistent style,
* they can all be readable in plain-text,
* in the process, I'll be able to catch/fix other problems (missing
or dead links, unclear / incorrect / incomplete / obsolete / redundant
info, typos, grammar),
* as a bonus, they can be easily converted to HTML (or viewed as HTML
on sites like GitHub).
The markup of choice is Markdown, mostly due to its good readability as
plain text (in fact I'm writing this in MD, as most of my e-mails). I'm
also following a [simple style guide][1] I have developed over years.
[1]:
https://github.com/AloisMahdal/mybook/blob/master/guidelines/markdown.md
First commit regarding this is [ad77376][2] in openlmi-providers, which
has already been [reviewed][3] and merged to master.
[2]:
https://git.fedorahosted.org/cgit/openlmi-providers.git/commit/?id=ad77376
[3]:
http://reviewboard-openlmi.rhcloud.com/r/2100/
I have already started working on rest of READMEs from openlmi-providers
and I'll be soon posting first batch of commits. Stay tuned...
Thanks,
aL.
--
Alois Mahdal <amahdal(a)redhat.com>
Platform QE, BaseOS Daemons
#qa, #brno, #daemons