diff options
| author | Alexander Pickering <alex@cogarr.net> | 2020-07-05 17:57:26 -0400 |
|---|---|---|
| committer | Alexander Pickering <alex@cogarr.net> | 2020-07-05 17:57:26 -0400 |
| commit | bab5088df8e707bdcfe4a43eb1584b16a18a4ecb (patch) | |
| tree | de2a644b667cf187dd12ef9105006f55286df37a /README.md | |
| parent | e87b06ee0fe2a588b72a356bbb8378899365d626 (diff) | |
| download | mdoc-bab5088df8e707bdcfe4a43eb1584b16a18a4ecb.tar.gz mdoc-bab5088df8e707bdcfe4a43eb1584b16a18a4ecb.tar.bz2 mdoc-bab5088df8e707bdcfe4a43eb1584b16a18a4ecb.zip | |
Update readme
Updated the rockspec to build automatically, and updated the
readme to inclue installation and usage instructions.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
@@ -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 <folder> [-p <folder> ...][ -o <folder>][ -t "title"][ -i <file>][ -d <folder>[ -d <folder> ...]][ -m <executable>][ -h]
+
+ -p | --path <folder> : Path to search for source files
+ -o | --output <folder> = "." : Folder to output HTML files to (and a cache folder)
+ -t | --title "name" = "Mdoc Generated Page" : Title for the html files
+ -i | --index <file> : File to use for the index file
+ -d | --document <folder> : Path to search for files to put inder the References section
+ -m | --markup-parser <executable> : 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)
+
|