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.
You're viewing a single thread.
4 comments
-
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
-
man ./README
eliminating the need to view the raw source
What about servers where only required softwares are installed.
-
If one chooses to forgo the manual pages and the manual page viewer, that's one's own problem to solve.
-
-
-
Why?
-
Largely because I both like it and think it under-utilized.
-
-