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

  • erpicht
    81·
    2 years ago

    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

      • erpicht
        2·
        2 years ago

        Oh, that’s another way to do it–neat! :)

    • cout
      2·
      2 years ago

      man ./README

      eliminating the need to view the raw source

      What about servers where only required softwares are installed.

      • erpicht
        41·
        2 years ago

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

          • cout
            23·
            2 years ago

            Markdownreader pre installed

            There is no such thing as markdown Reader. Markdown can be read by cat command.

            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.

              • cout
                1·
                2 years ago

                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.