v2 / vlib / v / help / FORMATTING.md
31 lines · 22 sloc · 819 bytes · c8c70de87d07c7b4e9f0043420f67eb4bdd84fe9
Raw

Formatting a Help File

Requirements

Example

Adding a help file was made to be easy. All you have to do is create the text file in the appropriate category, and V should recognize it.

Short description of what it does

Usage:
  v COMMAND (args and such here)

Longer description of what your command aims to do (optional)

Examples: (optional)
  v COMMAND -arg1 -arg2
  
Options:
  -h, --help      Help menu
  -s, --short     Description of short
  -l, --long      Description of long