From 69dafc5d97d05a697958b975d401248ebc492363 Mon Sep 17 00:00:00 2001 From: Alexander M Pickering Date: Sat, 11 Oct 2025 13:12:32 -0500 Subject: Update readme's links. --- README.md | 104 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 52 insertions(+), 52 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 12f40ad..072abe6 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,52 @@ -# MDoc - -## Overview - -A documentation engine for Lua - -MDoc was built after frustrations with -[LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html), -the usual and most popular documentation engine for lua. Like LDoc, MDoc uses -comments in the source code to generate html files for documentation. Unlike -LDoc, it makes no attempts to be backwards compatible with LuaDoc. This results -in a documentation engine that is free from constraints like "One class per -file" or "one module per file", and allows for an architecture that is more -consistent and elegent overall. MDoc is still in it's early stages, expect -frequent code churn in the near future. - -MDoc is used to document my homebrew game engine and VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/), -and you can see an example of mdoc in action at the [Brok\[en\]gine reference](https://cogarr.net/brokengine/). - -## 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) - +# MDoc + +## Overview + +A documentation engine for Lua + +MDoc was built after frustrations with +[LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html), +the usual and most popular documentation engine for lua. Like LDoc, MDoc uses +comments in the source code to generate html files for documentation. Unlike +LDoc, it makes no attempts to be backwards compatible with LuaDoc. This results +in a documentation engine that is free from constraints like "One class per +file" or "one module per file", and allows for an architecture that is more +consistent and elegent overall. MDoc is still in it's early stages, expect +frequent code churn in the near future. + +MDoc is used to document my homebrew game engine and VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/), +and you can see an example of mdoc in action at the [Brok\[en\]gine reference](https://docs.cogarr.net/brokengine/). + +## 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