Skip to content

Instantly share code, notes, and snippets.

@jbenner-radham
Created October 20, 2024 23:03
Show Gist options
  • Save jbenner-radham/f97579094cf3e8221590f3a554d98791 to your computer and use it in GitHub Desktop.
Save jbenner-radham/f97579094cf3e8221590f3a554d98791 to your computer and use it in GitHub Desktop.
Manpage for my readme-md-cli Node.js app
.Dd $Mdocdate$
.Dt README-MD 1
.Os
.\"
.Sh NAME
.\" ====
.Nm readme-md
.Nd Automatically generate a readme for your project from the CLI.
.\"
.Sh SYNOPSIS
.\" ========
.Nm
.Op Fl h
.Op Fl n
.Op Fl v
.Op Ar init
.\"
.Sh DESCRIPTION
.\" ===========
Automatically generates a readme for your project by interpreting various files
and metadata. When invoked without any options it will launch into an
interactive prompt and ask you questions about your project before generating
your readme.
.Pp
Its options are as follows:
.Bl -tag -width Ds
.It Fl h, -help
Display the help message.
.It Fl n, -non-interactive
Run the program in non-interactive mode. This will not ask you questions and
will use default settings if a configuartion is not present.
.It Fl v, -version
Displays the version number of the application.
.It Ar init
Initialize a new configuartion file.
.\"
.Sh EXIT STATUS
.\" ===========
.Ex -std
.\"
.Sh AUTHORS
.\" =======
.An James Benner Aq Mt [email protected]
.Pq Lk https://www.jamesbenner.com/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment