search

lttng / lttng-scope

A trace viewer and analyzer for LTTng kernel and user space traces
https://lttng.org/beta/#lttng-scope
Eclipse Public License 1.0
28 stars 6 forks source link

Use README.adoc instead of README.md and follow LTTng-docs contrib guide #1

Closed eepp closed 7 years ago

eepp commented 7 years ago

AsciiDoc offers much more than MD here and it will prove useful as we add more and more text and sections to the README.

I also adapted the text's style to follow the contributor's guide of LTTng-docs so that all the project under the LTTng umbrella show a consistent style in their documentation.

ghost commented 7 years ago

I have to admit I really like MD, because the "source" remains very readable as a plain text file. I would often copy-paste commands from this file into the terminal (like the mvn clean install -Dmaven.test.skip=false). Those commands seem to remain intact with adoc, so that's good. Aligning with the other LTTng projects is a laudable goal too.

eepp commented 7 years ago

because the "source" remains very readable as a plain text file

Yes, AsciiDoc does not pretend that its language is human-readable like Markdown does. The goal is always to convert the source to a rich output (DocBook, HTML, etc.).