Skip to content

Latest commit

 

History

History
4 lines (3 loc) · 614 Bytes

CONTRIBUTE.adoc

File metadata and controls

4 lines (3 loc) · 614 Bytes

Documentation

The documentation is done in Asciidoc and available under the doc/ folder in the repository. A number of conventions should be followed when documenting.

All TerminalCommands should be documented with their expected input and output. The inputParameters that can be changed by the user should be given in square brackets [param]. Optional parameters should be given in curly brackes {opt_param = 0} with a default value. A Template documentation file is available here: DocumentationTemplate.