summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/gitfile-info/README
blob: af1aea72c3290edd040abbd06be9777c49dd0203 (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+
|                                                                                                  |
| PACKAGE `gitfile-info'                                                                           |
|                                                                                                  |
	If you are using git to control versions of \LaTeX-files, you may want to show yourself or
	other users or devs the current version of the file, information about the author and last
	edited date. All packages for git known make that kind of information available for the whole
	repository. But sometimes you have a lot of files within the same repository in different
	versions, from different authors etc. Perhaps you also split up a big project in small files
	and want to show within the document who had edited what. This package gives you the
	opportunity to do so.
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+
  Version: 0.1
  Last Change: 2016-06-27
  Current Maintainer: André Hilbig 
                      mail@andrehilbig.de
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+
 
  This work may be distributed and/or modified under the
  conditions of the LaTeX Project Public License, either version 1.3
  of this license of (at your option) any later version.
  The latest version of this license is in
    http://www.latex-project.org/lppl.txt
  and version 1.3 or later is part of all distributions of LaTeX
  version 2005/12/01 or later.
 
  This work has the LPPL maintenance status `maintained'.
 
  This work consists of the files gitfile-info.sty, gfi-run, post-commit, post-merge.
|                                                                                                  |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+
|                                                                                                  |
| Installation                                                                                     |
|                                                                                                  |
  Getting the files:
		latex gitfile-info.ins

  Getting the documentation:
		latexmk -pdf gitfile-info.dtx

  Copy the following file into a TeX-readable directory:
    gitfile-info.sty

	Copy the hooks into .git/hooks:
		post-commit
		post-merge

	Copy the init-script into a executable directory, maybe within the git-repo to post it to the
	other users:
		gfi-run
|                                                                                                  |
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -+