Skip to content

Commit

Permalink
Small text changes and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Tuomas Jomppanen committed Sep 24, 2010
1 parent 8f43b54 commit 9b506be
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Git repository viewer plugin for Dokuwiki
=========================================

Please notice, that this is barely usable at the moment.
I made this for my own use, so the code is very very ugly.
I made this for my own usei only, so the code is very very ugly.

The main idea is this:

Expand All @@ -11,16 +11,16 @@ git commit -m "Fixed a typo bug #bug24"
After committing, the wiki plugin will show commit messages and
convert "#bug24" into internal link to bug-page with correct anchor.

Also this works too:
It also workd this way too:

git commit -m "Started working for login page (#ft4)"

The "#ft4" is transformed into internal link to features page also
anchoring into #ft4 (you need bookmark-plugin for creating those anchors)
The "#ft4" is transformed into internal link to features page and creating
hyperlink into #ft4 (you need bookmark-plugin for creating those anchors)

Just add this into wiki page:

<dokugitviewer:repository=my-repository features=backlog bugs=bugdb limit=15>
<dokugitviewer:repository=my-repository-name features=backlog bugs=bugdb limit=15>

And it will build you a list of your latest commits

Expand All @@ -29,6 +29,11 @@ Requirements:
PHP5
Git

This plugin is licensed as GPL.
Installation:
1) Clone this repository into plugins/ directory in your dokuwiki directory
2) Edit the config.inc.php file
3) Add <dokugitviewer> link into your wiki page

Dokuwiki: http://www.dokuwiki.org

Author: Tuomas Jomppanen (http://www.jomppanen.com)

0 comments on commit 9b506be

Please sign in to comment.