this post was submitted on 25 Jul 2022
5 points (100.0% liked)

General Programming Discussion

7989 readers
4 users here now

A general programming discussion community.

Rules:

  1. Be civil.
  2. Please start discussions that spark conversation

Other communities

Systems

Functional Programming

Also related

founded 5 years ago
MODERATORS
 

troff is a simple text format, so I thought about using it for a README.

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 7 points 2 years ago (12 children)

Do note, however, that troff is generally used to output PostScript or PDF files, while nroff is 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 ./README

There, no markdown pager, or reading of raw markdown necessary. Do not heed those others, who speak of "accepted standards." :P

[–] [email protected] 2 points 2 years ago* (last edited 2 years ago) (9 children)

man ./README

eliminating the need to view the raw source

What about servers where only required softwares are installed.

[–] [email protected] 3 points 2 years ago* (last edited 2 years ago) (1 children)

If one chooses to forgo the manual pages and the manual page viewer, that's one's own problem to solve.

load more comments (7 replies)
load more comments (9 replies)