You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+11-7
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,23 @@
5
5
A LaTeX package which provides macros integrated with LuaTeX and the commandline tool `git`.
6
6
7
7
## 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.
10
11
11
12
## 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`:
13
15
```bash
14
-
make build clean
15
-
# Or manually
16
+
# Using the original TEXMFHOME and the project directory
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`.
21
25
22
26
See the [releases section](https://github.com/Xerdi/gitinfo-lua/releases) for getting the latest manual.
0 commit comments