When  you publish a free software project, you usually write some sort
 of documentation. My choice of preference is a manpage because it's so
 easy  and  convenient  to  type "man whatever" and be presented with a
 good manual.

 Online platforms like GitHub promote usage of README files.

 For the last couple of years, I have just done this:

   1   man -M . mytool >README

 Hmm...

 This was pretty lazy. I only did this to satisfy GitHub because it  so
 badly wants to show a README.

 I  have  recently  fixed  this. I have added a proper README to all my
 projects. The rule of thumb goes like this:

   -- A  README  contains  a  brief  description  of  the  program  and
      everything  you need to know before installing the program. As an
      additional teaser, it also contains  a  short  "Running"  section
      with a rough outline of what you can do with the program.

   -- Afterwards,  you  can  have  a look at the manpage to get to know
      more details like command line switches. Manpages  are  reference
      manuals and tell you how you operate the program.

You are viewing proxied material from uninformativ.de. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.