Skip to content

Instantly share code, notes, and snippets.

@schas002

schas002/README.md

Last active May 15, 2018 11:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save schas002/d20007a37cd8c19b16082e5323da3656 to your computer and use it in GitHub Desktop.
Save schas002/d20007a37cd8c19b16082e5323da3656 to your computer and use it in GitHub Desktop.
Download ZIP
A generic README for CWEB literate programs.
Raw
README.md

[name]

[synopsis]

[description]

Install

[name] is a CWEB literate program. It can be ctangled to make a C source code file:

$ ctangle [name].w  # creates [name].c
$ c99 -o [name] [name].c

and cwoven to make a definitive document on the program with TEX:

$ cweave [name].w  # creates [name].tex
$ pdftex [name].tex

Usage

$ ./[name] [arguments]

FAQ

But where are the docs?

The cwoven document is your docs.

[extra sections]

Maintainer

  • [maintainer] - [maintainer GitHub] - [maintainer address]

Contribute

[contribute]

License

[license]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment