diff options
Diffstat (limited to 'support/latex-git-log/README.md')
| -rw-r--r-- | support/latex-git-log/README.md | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/support/latex-git-log/README.md b/support/latex-git-log/README.md index f3d5f15f2c..c186186418 100644 --- a/support/latex-git-log/README.md +++ b/support/latex-git-log/README.md @@ -1,7 +1,15 @@ +<!-- +SPDX-FileCopyrightText: 2013,2020,2024 Robin Schneider <ypid@riseup.net> + +SPDX-License-Identifier: GPL-3.0-or-later +--> + # latex-git-log This program will output the entire version history as table written in LaTeX if it is executed within a git repository. +When file argument(s) are given, only the history that changed these file(s) +will be output. It is intended that you redirect the standard output of this script to a file which can then be included from your main LaTeX document. @@ -12,7 +20,7 @@ landscape page. ### Of this script -This module requires these other modules and libraries: +This script requires the following Perl modules: IPC::System::Simple Locale::Maketext::Simple @@ -25,27 +33,25 @@ The table is using the *longtable* package and the links to a web resource for each commit use the `\href` macro from *hyperref*. So these two packages have to be loaded. -Furthermore you need to defined the macro `\longtableendfoot` which will be +Furthermore you need to define the macro `\longtableendfoot` which will be expanded on the bottom of every page if the table will be continued on the next page. You can defined it to a localized message to inform the reader that this table is not complete and will be continued. ## License and development -Copyright (C) 2012-2013,2017,2019-2020 Robin Schneider <ypid@riseup.net> <br/> -SPDX-License-Identifier: GPL-3.0-or-later <br/> +License: GPL-3.0-or-later <br/> CTAN: https://ctan.org/pkg/latex-git-log <br/> Source code repository: https://github.com/ypid/typesetting/tree/master/scripts/latex-git-log <br/> Please report bugs and feature requests at https://github.com/ypid/typesetting/issues ## Usage - latex-git-log [options] + latex-git-log [options] [file] ... Options: --author set this if you want the author included - --startcommit set the start value of count commit --width set the width in cm of the commit message field in the LaTeX table --git-c-add set an base URL to link to a commit --user set a github user to derive the base URL @@ -80,3 +86,7 @@ Please report bugs and feature requests at https://github.com/ypid/typesetting/i need a translation to another language then you can either create a .po file or I can register this project on one of those websites for online translation. + +## Bugs and limitations + +* The translation features does not seem to work. So this script is unable to output German. English works. |