Remote View
Should I use a troff format for a README?
Should I use a troff format for a README?
troff is a simple text format, so I thought about using it for a README.
4 comments
-
Traditionally README files have been the plainest of plain text to facilitate their widest accessibility.
Markdown does seem to provide some opportunity for optional formatting without too much ugliness when viewed as plain text.
-
I would say stick with
Markdownas it's easier to write. Also it's more readable in raw state.
-
Markdown is generally accepted as standard these days
-
YES. Absolutely the correct choice.
-
Do note, however, that
troffis generally used to output PostScript or PDF files, whilenroffis used for the internal manpage formatting. The GNU version,groff, combines them into one. If one makes a README meant to be read in a terminal, the following will present a formatted version to the viewer, eliminating the need to view the raw source:man ./READMEThere, no markdown pager, or reading of raw markdown necessary. Do not heed those others, who speak of "accepted standards." :P
-
Why?
-
Largely because I both like it and think it under-utilized.
-
-