Merge remote branch 'zts/pod-cleanup' into release

[catagits/Gitalist.git] / README

diff --git a/README b/README
index 301b317..a66541b 100644 (file)
--- a/README
+++ b/README
@@ -2,19 +2,25 @@ NAME
     Gitalist - A modern git web viewer
 
 SYNOPSIS
-        script/gitalist_server.pl
+        script/gitalist_server.pl --repo_dir /home/me/code/git
 
 INSTALL
     As Gitalist follows the usual Perl module format the usual approach for
-    installation should work e.g
+    installation should work e.g.
 
       perl Makefile.PL
       make
       make test
       make install
 
-    If you're running a git checkout of Gitalist then you'll additionally
-    need the author modules.
+    or
+
+      cpan -i Gitalist
+
+    You can also check gitalist out from git and run it, in this case you'll
+    additionally need the author modules, but no configuration will be
+    needed as it will default to looking for repositories the directory
+    above the checkout.
 
 DESCRIPTION
     Gitalist is a web frontend for git repositories based on gitweb.cgi and
@@ -26,6 +32,27 @@ DESCRIPTION
     Ragwitz's earlier effort, it was easier to use gitweb.cgi as a template
     for building a new Catalyst application.
 
+CONFIGURATION
+    Gitalist can be supplied with a config file by setting the
+    "GITALIST_CONFIG" environment variable to point to a configuration file.
+
+    A default configuration is installed along with gitalist, which is
+    complete except for a repository directory. You can get a copy of this
+    configuration by running:
+
+      cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
+
+    adding a repos_dir path and then setting "GITALIST_CONFIG".
+
+    Alternatively, if you only want to set a repository directory and are
+    otherwise happy with the default configuration, then you can set the
+    "GITALIST_REPOS_DIR" environment variable, or pass the "--repos_dir"
+    flag to any of the scripts.
+
+    The "GITALIST_REPOS_DIR" environment variable will override the
+    repository directory set in configuration, and will itself be overridden
+    by he "--repos_dir" flag.
+
 SEE ALSO
     Gitalist::Controller::Root