vet / help

:question: Automatic help command for your scripts directory
MIT License
2 stars 0 forks source link

Help

Automatic help command for your scripts directory.

Usage

To start, put help into your projects scripts directory.

Somewhere near the top of all of your scripts, put a comment at the top that briefly describes what the script does, like so:

## Uploads the source to the production server

This comment must immediatly follow two pounds and a space: ##.

If your script is not in a language that comments with pound signs, don't worry, this also works:

// ## Uploads the source to the production server

Now that everything is all setup, calling the help script outputs something that looks like this:

Sample Output

License

MIT