summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/gitinfo-lua/README.md
blob: 463e764fa1cfbc09f1bd07f41b956f949e343390 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Gitinfo Lua
![CTAN Version](https://img.shields.io/ctan/v/gitinfo-lua)
[![build](https://github.com/Xerdi/gitinfo-lua/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/Xerdi/gitinfo-lua/actions/workflows/build.yml)

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
```

See the [releases section](https://github.com/Xerdi/gitinfo-lua/releases) for getting the latest manual.

## License
This project is licensed under the LPPL version 1.3c and maintained by Erik Nijenhuis.
See [LICENSE.txt](LICENSE.txt) for more information.