Correct filename in HTTP response.

[catagits/Gitalist.git] / README

diff --git a/README b/README
index e478ece..4af4ae5 100644 (file)
--- a/README
+++ b/README
@@ -1,42 +1,53 @@
-Gitalist - a transitional project to convert gitweb.cgi to a Catalyst app.
+NAME
+    Gitalist - Transitional project to convert gitweb.cgi to a Catalyst app
 
-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
-"transitional" in the description).
+SYNOPSIS
+        script/gitalist_server.pl
 
-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.
+INSTALL
+    As Gitalist follows the usual Perl module format the usual approach for
+    installation should work e.g
 
-USAGE
+      perl Makefile.PL
+      make
+      make test
+      make install
 
-To get Gitalist up and running just set $projectroot in gitweb.conf to point
-to the directory contains your repositories. With that done the usual:
+    If you're running a git checkout of Gitalist then you'll additionally
+    need the author modules. *NB: As no distribution exists one will
+    presently need the author modules*.
 
-  perl script/gitalist_server.pl
+DESCRIPTION
+    Gitalist is a web frontend for git repositories based on gitweb.cgi and
+    backed by Catalyst. It doesn't yet have the full functionality of
+    gitweb.cgi but it does have a few small additions at this stage.
 
-should do the trick.
+  History
+    This project started off as an attempt to port gitweb.cgi to a Catalyst
+    app in a piecemeal fashion. As it turns out, thanks largely to Florian
+    Ragwitz's earlier effort, it was easier to use gitweb.cgi as a template
+    for building a new Catalyst application.
 
-DEPENDENCIES
+SEE ALSO
+    Gitalist::Controller::Root
 
-  Catalyst
-  IO::Capture::Stdout;
+    Gitalist::Git::Project
 
-COPYRIGHT AND LICENCE
+    Catalyst
 
-Copyright (C) 2009 Venda Ltd
+AUTHORS AND COPYRIGHT
+      Catalyst application:
+        (C) 2009 Venda Ltd and Dan Brook <broq@cpan.org>
+        (C) 2009, Tom Doran <bobtfish@bobtfish.net>
+        (C) 2009, Zac Stevens <zts@cryptocracy.com>
 
-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.
+      Original gitweb.cgi from which this was derived:
+        (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
+        (C) 2005, Christian Gierke
+
+      Model based on http://github.com/rafl/gitweb
+        (C) 2008, Florian Ragwitz
+
+LICENSE
+    Licensed under GNU GPL v2
 
-gitweb.cgi 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