1# Git repository log viewer for Dokuwiki
2
3This dokuwiki plugin displays your last commits for a given repository and the changed files.
4
5This plugin is based on: https://github.com/tuomasj/dokugitviewer
6
7## Demo
8
9![Image](screenshot.png?raw=true)
10
11## Requirements:
12
13  * Git
14  * PHP5
15
16## Installation:
17
18  - Clone or download this into plugins/ directory in your dokuwiki installation
19  - if nessecary, rename directory to "gitlog"
20  - activate plugin inside dokuwiki
21  - goto admin configuration page, section "plugin/gitlog" and set up plugin
22  - Add <gitlog> shortcode into your wiki page
23
24## Configuration
25
26#### Location of your git executable
27
28Usally ```/usr/bin/git``` on linux maschines.
29
30If you use git on windows, use ```git```.
31
32#### Root directory for your repositories
33
34Put here the path, where your repositories are. This is optional!
35
36You can customize the path to your repo also within the shortcode.
37
38#### Date format
39
40Use php ```date()``` format strings.
41
42http://www.php.net/manual/en/function.date.php
43
44## Usage
45
46Just add this into wiki page:
47
48````
49<gitlog:repository="my-repository-name" [dir="custom/path/to/repo/"] [bare="0"] [limit="10"]>
50````
51
52Parameters in brackets [] are optional. Please dont use brackets within shortcode!
53
54
55## Info
56
57Author: Alexander Wenzel (https://plus.google.com/+alexwenzel86)
58
59Plugin page: http://www.dokuwiki.org/plugin:gitlog