Bumped version and added bootstrap docs.

[catagits/Gitalist.git] / lib / Gitalist.pm

diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm
index 1be66c8..36f7098 100644 (file)
--- a/lib/Gitalist.pm
+++ b/lib/Gitalist.pm
@@ -14,13 +14,15 @@ use Catalyst qw/
                 SubRequest
 /;
 
-our $VERSION = '0.000006_01';
+our $VERSION = '0.002001_01';
 $VERSION = eval $VERSION;
 
 __PACKAGE__->config(
     name => 'Gitalist',
     default_view => 'Default',
     default_model => 'CollectionOfRepos',
+    use_request_uri_for_path => 1,
+    disable_component_resolution_regex_fallback => 1,
 );
 
 __PACKAGE__->setup();
@@ -111,6 +113,26 @@ The canonical repository for the master branch is:
 Gitalist is also mirrored to github, and a number of people have active forks
 with branches and/or new features in the master branch.
 
+=head1 BOOTSTRAPPING
+
+As of C<0.002001> Gitalist can now be bootstrapped to run out of its
+own directory by installing its prerequisites locally with the help of
+L<local::lib>. So instead of installing the prerequisites to the
+system path with CPAN they are installed under the Gitalist directory.
+
+To do this clone Gitalist from the Shadowcat repository mentioned
+above or grab a download from CPAN or broquaint's github repository:
+
+    http://github.com/broquaint/Gitalist/downloads
+
+With the source acquired and unpacked run the following from within the
+Gitalist directory:
+
+    perl script/bootstrap
+
+This will install the necessary modules for the build process which in
+turn installs the prerequisites locally.
+
 =head1 INITIAL CONFIGURATION
 
 Gitalist is configured using L<Catalyst::Plugin::Configloader>. The supplied sample
@@ -139,7 +161,7 @@ by running:
 
   cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
 
-You can then edit this confg, adding a repos_dir path and customising other settings as desired.
+You can then edit this confg, adding a repo_dir path and customising other settings as desired.
 
 You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. For example:
 
@@ -147,13 +169,13 @@ You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. F
 
 Alternatively, if you only want to set a repository directory and are otherwise happy with
 the default configuration, then you can set the C<< GITALIST_REPO_DIR >> environment
-variable, or pass the C<< --repos_dir >> flag to any of the scripts.
+variable, or pass the C<< --repo_dir >> flag to any of the scripts.
 
     GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
-    gitalist_server.pl --repos_dir home/myuser/code/git
+    gitalist_server.pl --repo_dir home/myuser/code/git
 
 The C<< GITALIST_REPO_DIR >> environment variable will override the repository directory set
-in configuration, and will itself be overridden by he C<< --repos_dir >> flag.
+in configuration, and will itself be overridden by he C<< --repo_dir >> flag.
 
 =head1 RUNNING
 
@@ -169,12 +191,11 @@ are running from a git checkout, adding a trivial FCGI script as C<script/gitali
 (this file is specifically in C<.gitignore> so you can have your own copy):
 
     #!/bin/sh
-    export PERL5LIB=/home/t0m/public_html/Gitalist/lib:/home/t0m/perl5/lib/perl5:$PERL5LIB
     exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
 
 This example can be seen live here:
 
-    http://goatse.co.uk/~bobtfish/Gitalist/script/gitalist.fcgi/
+    http://example.gitalist.com
 
 =head1 CONTRIBUTING