troff is a simple text format, so I thought about using it for a README.
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
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.
deleted by creator
deleted by creator
deleted by creator
Markdownreader pre installed
There is no such thing as markdown Reader. Markdown can be read by
catcommand.However, manpages is something that comes preinstalled in most server OSes with a few cases out there.
It doesn’t. See the link i posted in previous reply. Also windows.
Sometimes it also comes as dependency of one of the software you need to install by default so, these little cases are even less.
This question was about Readme not documentation.
deleted by creator
Please, don’t use aggressive language here, no-one is attacking you.
I don’t know when i was aggressive. You can see yourself that my previous replies(before i editied last one)it contained words like Please. I only removed please when someone downvoted my whole profile without specifying any reason.
yeah, they come. Most server OSes are custom images by IaaS providers with them.
You completely ignored Alpine,Arch,Gentoo and Windows.
Where you could not see it? in a Docker container using default Docker image.
Docker uses Alpine.
deleted by creator
Oh, that’s another way to do it–neat! :)
Why?
Largely because I both like it and think it under-utilized.
