Bound syntax-highlight memory and widen coverage

1 file changed, 18 insertions, 0 deletions

diff --git a/README.txt b/README.txt
index b1ab036..d3b32ec 100644
--- a/README.txt
+++ b/README.txt
@@ -84,6 +84,24 @@ cgit builds without OpenSSL or libcurl, so no development packages for those are
 needed.
 
 
+Filter extensions
+-----------------
+
+The optional Lua filters in `extensions/` need extra Lua modules. Each script's
+header lists the exact install commands for its own dependencies.
+
+* The auth filters (`auth-file.lua`, `auth-inline.lua`) need `luaossl` and
+  `luaposix`.
+* The email filters (`email-gravatar.lua`, `email-libravatar.lua`) need
+  `luaossl`.
+* The syntax highlighter (`syntax-highlight.lua`) needs `lpeg` and a Scintillua
+  lexer set.
+
+These filters target Lua 5.1 through 5.4 and LuaJIT. `luaossl` has no Lua 5.5
+build, so build cgit against 5.1 to 5.4 if you use the auth or email filters.
+`link-commits.lua` needs nothing beyond Lua itself.
+
+
 Web server configuration
 ------------------------