Skip to content

Commit 9afd383

Browse files
committed
Edit README
1 parent cb8fa55 commit 9afd383

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,23 @@
55
A LaTeX package which provides macros integrated with LuaTeX and the commandline tool `git`.
66

77
## Installation
8-
In order to install this package the right way, one should create the release tarball first with `make package`.
9-
Afterward be sure to unpack the contents of the release tarball anywhere where TeX will find it, i.e. `~/texmf`.
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.
1011

1112
## Documentation
12-
The documentation can be built using `make` or manually using `lualatex`:
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`:
1315
```bash
14-
make build clean
15-
# Or manually
16+
# Using the original TEXMFHOME and the project directory
17+
CNF_LINE="TEXMFHOME={$(pwd),$(kpsewhich --var-value TEXMFHOME)}"
1618
cd doc
17-
lualatex -shell-escape gitinfo-lua.tex
19+
lualatex --lua=gitinfo-lua-init.lua -bibtex -cnf-line $CNF_LINE gitinfo-lua
1820
makeindex -s gind.ist gitinfo-lua.idx
19-
lualatex -shell-escape gitinfo-lua.tex
21+
lualatex --lua=gitinfo-lua-init.lua -bibtex -cnf-line $CNF_LINE gitinfo-lua
2022
```
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`.
2125

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

0 commit comments

Comments
 (0)