Update README

This commit is contained in:
Marcel Krüger 2020-06-04 00:13:05 +02:00
parent 279a85109d
commit 6cc399b084

View File

@ -1,14 +1,12 @@
# (unofficial) LaTeX format for LuaMetaTeX
## Warning:
This code is in early stages of development and contains more bugs than features. _Do not_ expect it too be compatible with normal documents yet. Also later versions will contain many breaking changes.
This code is in early stages of development and contains more bugs than features. _Do not_ expect it to be compatible with normal documents. Also later versions will contain many breaking changes.
## Prerequisites
You need an up-to-date TeX Live installation and the latest, not yet released, development versions of [lualibs (branch v2.6701-2019-07-04)](https://github.com/u-fischer/lualibs/tree/v2.6701-2019-07-04) and [luaotfload (branch v2.9901-2019-07-04-PR72)](https://github.com/u-fischer/luaotfload/tree/v2.9901-2019-07-04-PR72).
You need an up-to-date TeX Live installation and the latest version of LuaMetaTeX.
Also we use a FFI binding of kpathsea, so you need `libkpathsea.so` in you system paths.
If you have installed TeX Live through your package manager this shouldn't be a problem, even if you do not actually use that version.
Otherwise you might have to compile it yourself.
Additionally a special library version of LuaTeX's kpathsea Lua binding is needed which is provided as a binary for Linux x64. For other platforms you might have to compile it yourself. Drop me a line if you need any instructions.
## How to install
Obtain `luametatex` from ConTeXt, drop the binary into the same location where your `luatex` binary is installed and copy (or sym-link) the file `luametalatex.lua` into the same directory. Additionally create a sym-link `luametalatex` to `luametatex` in the same directory. Then copy (or sym-link) this entire repo to `.../texmf-local/tex/lualatex/luametalatex`.