| 1 |
# Gitinfo Lua |
| 2 |
 |
| 3 |
[](https://github.com/Xerdi/gitinfo-lua/actions/workflows/build.yml) |
| 4 |
|
| 5 |
A LaTeX package which provides macros integrated with LuaTeX and the commandline tool `git`. |
| 6 |
|
| 7 |
## Installation |
| 8 |
The recommended way of installing is using `tlmgr install gitinfo-lua`. |
| 9 |
If you can't update/install packages with `tlmgr`, you can download the latest `gitinfo-lua-<version>.tds.tar.gz` from the [releases page](https://github.com/Xerdi/gitinfo-lua/releases) and then unpack it in your `TEXMFHOME`. |
| 10 |
To find out where your `TEXMFHOME` is, you can consult `kpsewhich --var-value TEXMFHOME` on the commandline. |
| 11 |
|
| 12 |
## Documentation |
| 13 |
A prerequisite is that you have the [texmf-packaging](https://github.com/Xerdi/texmf-packaging) available in your `TEXMFHOME`. |
| 14 |
The documentation can be built using `make build clean` or manually using `lualatex`: |
| 15 |
```bash |
| 16 |
# Using the original TEXMFHOME and the project directory |
| 17 |
CNF_LINE="TEXMFHOME={$(pwd),$(kpsewhich --var-value TEXMFHOME)}" |
| 18 |
cd doc |
| 19 |
lualatex --lua=gitinfo-lua-init.lua --cnf-line $CNF_LINE gitinfo-lua |
| 20 |
makeindex -s gind.ist gitinfo-lua.idx |
| 21 |
lualatex --lua=gitinfo-lua-init.lua --cnf-line $CNF_LINE gitinfo-lua |
| 22 |
``` |
| 23 |
To do the same as the Lua initialization script, commandline option `--shell-restricted` should be passed and `git` should be added to `shell_escape_commands` in your `texmf.cnf`. |
| 24 |
The `texmf.cnf` file to edit can be found with `kpsewhich texmf.cnf`. |
| 25 |
|
| 26 |
See the [releases section](https://github.com/Xerdi/gitinfo-lua/releases) for getting the latest manual. |
| 27 |
|
| 28 |
## License |
| 29 |
This project is licensed under the LPPL version 1.3c and maintained by Erik Nijenhuis. |
| 30 |
See [LICENSE.txt](LICENSE.txt) for more information. |