+

Add README file

Benjamin Renard [2013-08-21 17:34:24]
Add README file
Filename
README
diff --git a/README b/README
new file mode 100644
index 0000000..83cf575
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+ProjectInfos plugin for ViewGit
+===============================
+
+This plugin display project informations on summary page :
+
+* description
+* last change
+* Git repository's URLs (if defined in project declaration)
+
+The Git repository URLs could be define using key 'url' in variable
+$conf['projects'].
+
+Example :
+
+$conf['projects']['myproject'] = array(
+	'repo' => '/path/to/my/repo',
+	'url' => array (
+		'git@git.example.com:public_git/myproject',
+		'http://git.example.com/git/myproject'
+	)
+);
+
+Install
+-------
+
+* Put projectinfos directory in plugins directory
+* (Optionnaly) Define project's Git URL in inc/localconfig.php file
ViewGit