| title | author | date | |
|---|---|---|---|
README(1) | Geodesic |
|
May 2019 |
README - Documentation for Geodesic
This directory contains a number of markdown-formatted "man" pages. These will be available inside of the container.
To rebuild the man pages, run docs update
To list all available man pages, run help. Then for more information on any topic, run help and pass the command as an argument.
To search for help, run help "topic" where "topic" is what you want more information on.
All documentation for geodesic belongs in the docs/ folder. Use markdown appropriate formatting and styles.
In order to be consistent with UNIX Man pages, all section titles should be UPPERCASE and begin with a single ##.
Subsections should be properly capitalized and use ###. Avoid going more than (2) sections deep.
Use standard section names.
## NAMEThe name of the command or function, followed by a one-line description of what it does.## SYNOPSISIn the case of a command, a formal description of how to run it and what command line options it takes. For program functions, a list of the parameters the function takes and which header file contains its declaration.## DESCRIPTIONA textual description of the functioning of the command or function.## EXAMPLESSome examples of common usage.## SEE ALSOA list of related commands or functions.## OPTIONSA list of supported options for the command## SYNTAXAn explation of the command's syntax## ENVIRONMENTA list of supported environment variables## RETURN VALUESA breakdown of the expected return values or exit codes## STANDARDSSome of the "best practices"## SECURITY CONSIDERATIONSRecommended settings for safer operation## BUGSSome known issues## HISTORYBackground on command to give readers more context