From bab5088df8e707bdcfe4a43eb1584b16a18a4ecb Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Sun, 5 Jul 2020 17:57:26 -0400 Subject: Update readme Updated the rockspec to build automatically, and updated the readme to inclue installation and usage instructions. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index d9fb25e..32a2fa0 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,33 @@ and you can see an example of mdoc in action in the [Brok\[en\]gine reference]. ## Installation The easiest way to download MDoc is with [luarocks](https://github.com/luarocks/luarocks) + +``` +luarocks install --server=http://rocks.cogarr.net mdoc +``` + +## Usage + +`mdoc` or `mdoc --help` prints help information: + +``` +mdoc -p [-p ...][ -o ][ -t "title"][ -i ][ -d [ -d ...]][ -m ][ -h] + + -p | --path : Path to search for source files + -o | --output = "." : Folder to output HTML files to (and a cache folder) + -t | --title "name" = "Mdoc Generated Page" : Title for the html files + -i | --index : File to use for the index file + -d | --document : Path to search for files to put inder the References section + -m | --markup-parser : Executable to use to parse the descriptions and refrence documents. + Executable should accept a file path as it's argument, and generate html as it's output. + -h | --help : print this help + -v | --verbose : print extra information during run + -c | --no-cache : rebuild files, even if they're not out of date. +``` + +## Bugs + +Please report bugs or mail patches to [alex@cogarr.net](mailto://alex@cogarr.net) + +You can find instructions for creating patches [here](https://cogarr.net/source/cgit.cgi/?p=about) + -- cgit v1.2.3-70-g09d2