Mercurial > repos > lgen / file diff

--- a/README.md	Mon Jul 06 09:36:27 2020 -0500
+++ b/README.md	Mon Jul 06 10:56:23 2020 -0500
@@ -2,20 +2,35 @@
 # lgen
 
 This is a very simple website templating engine based on markdown and Lua,
-written by Tuomo Valkonen 〈<tuomov@iki.fi>〉.
+written by Tuomo Valkonen ⟨<tuomov@iki.fi>⟩.
 
 It is not particularly supported or maintained; it was created back in 2009
 to build [my own website](http://tuomov.iki.fi/). The engine is still being
 used for that purpose. I decided to put the code online in 2017 after
-having had to spend some time to convert it to Lua 5.3 from which the
-module() function had been removed.
+having had to spend some time to convert it from earlier versions to [Lua 5.3][Lua] from which the `module()` function had been removed.
 
-Features (see the included example):
+## Features
+
+For details see the included example.
 
   * Embedded Lua code with the ltp engine.
-  * Advanced markdown features, including syntax highlighting of code blocks, via Pandoc
-    (select `renderer: pandoc` in the page meta section).
+  * Advanced markdown features, including syntax highlighting of code blocks
+    and LaTeX mathematics via
+    [markdown-it][] and [KaTeX][] or [Pandoc][]. Markdown-it is now the default renderer. To select lua-markdown, use `renderer: lua-markdown` in the page YAML meta section. Use `renderer: pandoc` for Pandoc.
+
+## Installation
+
+You need to install [Lua 5.3][Lua].
+To use [markdown-it][], you need to install [NodeJS][] and then execute `npm install` to install in the top directory of this project.
+
+## License
 
 Aside from the included `compat_env.lua` and the ltp engine (which is has not
 updated to Lua 5.3, and requires on the compat_env module), the code is in
 the public domain.
+
+[KaTeX]: https://katex.org/
+[markdown-it]: https://github.com/markdown-it/markdown-it
+[Pandoc]: https://pandoc.org/
+[Lua]: http://www.lua.org/
+[NodeJS]: https://nodejs.org/en/