diff options
| author | Alexander Pickering <alex@cogarr.net> | 2020-07-13 12:43:37 -0400 |
|---|---|---|
| committer | Alexander Pickering <alex@cogarr.net> | 2020-07-13 12:43:37 -0400 |
| commit | 7ff0a0752a1092bd07042fb0357a5b571a386648 (patch) | |
| tree | 594c56d73c9601161ba35d89014c3b3468b5b902 /README.md | |
| parent | 3a663a8eb27bd2c03a765c0d326a134b28980032 (diff) | |
| download | mdoc-7ff0a0752a1092bd07042fb0357a5b571a386648.tar.gz mdoc-7ff0a0752a1092bd07042fb0357a5b571a386648.tar.bz2 mdoc-7ff0a0752a1092bd07042fb0357a5b571a386648.zip | |
Include full path for cdnjs
Include the full path for CDN delivery of highlight scritps to
allow the user to browse the files from local without starting
up a web server.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -6,15 +6,16 @@ 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 users
+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". MDoc is still in it's early stages, expect
+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 VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/),
-and you can see an example of mdoc in action in the [Brok\[en\]gine reference](https://cogarr.net/brokengine/).
+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
|