Intermediate commit on the way to switching to Git::PurePerl.

[catagits/Gitalist.git] / README

diff --git a/README b/README
index ecd7084..f4294ca 100644 (file)
--- a/README
+++ b/README
@@ -4,21 +4,33 @@ The idea behind this project is to move gitweb.cgi away from a single
 monolithic CGI script and into a modern Catalyst app. Fortunately this is not
 as daunting as it might seem at first as gitweb.cgi follows an MVC type
 structure. Once gitweb.cgi has been suitably Catalysed then it can move from
-being a "this was once gitweb.cgi" to a project of its own (hence the
+being "this was once gitweb.cgi" to a project of its own (hence the
 "transitional" in the description).
 
 As it stands Gitalist is very much in its infancy and hasn't got far
-beyond a layout template and a single controller. Probably the next step is
-moving an existing action into a new Catalyst action and lay down the code
-to make porting further actions, or writing new ones, as simple as possible.
-After that provide a model based on one of the git modules, either the Git.pm
-that comes with git or Git::PurePerl, and deprecate or port the existing
-gitweb.cgi functions.
+beyond a layout template and a single controller.
+
+USAGE
+
+To get Gitalist up and running just set projectroot & repo_dir (one in
+the same unfortunately at this point) in gitalist.conf to point to the
+directory that contains your repositories. With that done just run:
+
+  perl script/gitalist_server.pl
 
 DEPENDENCIES
 
   Catalyst
-  IO::Capture::Stdout;
+  IO::Capture::Stdout
+  Catalyst::View::ContentNegotiation::XHTML
+  Template::Plugin::Cycle
+  DateTime
+  Path::Class
+  File::Find::Rule;
+  DateTime::Format::Mail
+  File::Stat::ModeString
+  List::MoreUtils
+  # Probably others ...
 
 COPYRIGHT AND LICENCE
 
@@ -28,6 +40,6 @@ This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.8.8 or,
 at your option, any later version of Perl 5 you may have available.
 
-gitweb.cgi is based on the gitweb.perl from git-1.6.3.3
+gitweb.pm is based on the gitweb.perl from git-1.6.3.3
 (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
 (C) 2005, Christian Gierke