Add fuzzer script (pick something recent off arXiv)
[llf.git] / README
blob8be3aec7399ee41c2d5ef6e7dedd87b8f711e0b1
1 This is LLF, which either stands for Lua LaTeX Formatter or LaTeX-Like
2 Formatter.  I forget which.
4 To use it, run
6     lua /path/to/llf.lua < input.tex > output.tex
8 It should reformat your LaTeX in a way that preserves semantic meaning,
9 yet has intelligent indentation levels. It might not, since it doesn't
10 actually parse LaTeX, rather it parses a language which is almost LaTeX,
11 except for the whole Turing Complete bit.
13 Features:
15  - Understands verbatim environments
16  - Might handle your pseudocode environments right
17  - Won't mangle your align* or tabular environments
18  - Will treat everything between ‘%noformat{’ and ‘%}noformat’
19    as verbatim
20  - Acts like cat(1) if it can't parse your input
21  - Configure by copying llfrc.lua to ${XDG_CONFIG_HOME}/llf/llfrc.lua
22    or ${HOME}/.config/llf/llfrc.lua
24 Dependencies:
26  - lpeg    http://www.inf.puc-rio.br/~roberto/lpeg/lpeg.html
27  - wcwidth https://luarocks.org/modules/aperezdc/wcwidth
28  - utf8    (Should be built-in in >=5.3, not sure about other versions)
30 Licensed under ISC.
32 Please report bugs to S. Gilles <sgilles@math.umd.edu>. Minimal test
33 cases are great. Patches are even better.