summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/gitinfo-lua/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/latex/gitinfo-lua/README.md')
-rw-r--r--macros/luatex/latex/gitinfo-lua/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/macros/luatex/latex/gitinfo-lua/README.md b/macros/luatex/latex/gitinfo-lua/README.md
new file mode 100644
index 0000000000..383cf2df33
--- /dev/null
+++ b/macros/luatex/latex/gitinfo-lua/README.md
@@ -0,0 +1,24 @@
+# Git LaTeX
+
+A LaTeX package which provides macros integrated with LuaTeX and the commandline tool `git`.
+
+## Installation
+In order to install this package the right way, one should create the release tarball first with `make package`.
+Afterward be sure to unpack the contents of the release tarball anywhere where TeX will find it, i.e. `~/texmf`.
+
+## Documentation
+The documentation can be built using `make` or manually using `lualatex`:
+```bash
+make build clean
+# Or manually
+cd doc
+lualatex -shell-escape gitinfo-lua.tex
+makeindex -s gind.ist gitinfo-lua.idx
+lualatex -shell-escape gitinfo-lua.tex
+```
+
+Read [gitinfo-lua.pdf](gitinfo-lua.pdf) for more information about this package.
+
+## License
+This project is licensed under the LPPL version 1.3c and maintained by Erik Nijenhuis.
+See [LICENSE.pdf](LICENSE.pdf) for more information.