diff options
Diffstat (limited to 'macros/luatex/generic/luakeys/README.md')
-rw-r--r-- | macros/luatex/generic/luakeys/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/macros/luatex/generic/luakeys/README.md b/macros/luatex/generic/luakeys/README.md new file mode 100644 index 0000000000..cb4c429d4c --- /dev/null +++ b/macros/luatex/generic/luakeys/README.md @@ -0,0 +1,52 @@ +# luakeys + +`luakeys` is a Lua module that can parse key-value options like the +TeX packages [keyval](https://www.ctan.org/pkg/keyval), +[kvsetkeys](https://www.ctan.org/pkg/kvsetkeys), +[kvoptions](https://www.ctan.org/pkg/kvoptions), +[xkeyval](https://www.ctan.org/pkg/xkeyval), +[pgfkeys](https://www.ctan.org/pkg/pgfkeys) etc. do. `luakeys`, +however, accompilshes this task entirely, by using the Lua language and +doesn’t rely on TeX. Therefore this package can only be used with the +TeX engine LuaTeX. Since `luakeys` uses +[LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/), the parsing +mechanism should be pretty robust. + +## License + +Copyright 2021 Josef Friedrich + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3c +of this license or (at your option) any later version. +The latest version of this license is in + +http://www.latex-project.org/lppl.txt + +and version 1.3c or later is part of all distributions of LaTeX +version 2008/05/04 or later. + +This work has the LPPL maintenance status `maintained`. + +The Current Maintainer of this work is Josef Friedrich. + +## Tasks + +### Installing + +``` +make install +``` + +### Testing + +``` +luarocks install luaunit +lua test/tests.lua +``` + +or + +``` +make test +``` |