X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=301b317ab4613bcbe29b21da6722896b1cc6db81;hb=bba40bd5e51c35973a704153b1061601580f2159;hp=50b37266302909bc5bdfdba98f0f6f0332dd0dd2;hpb=569659f2074dc15eb4a2bef01eb9cd252ca605a9;p=catagits%2FGitalist.git diff --git a/README b/README index 50b3726..301b317 100644 --- a/README +++ b/README @@ -1,40 +1,51 @@ -Gitalist - a transitional project to convert gitweb.cgi to a Catalyst app. +NAME + Gitalist - A modern git web viewer -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 that contains your repositories. With that done just run: + If you're running a git checkout of Gitalist then you'll additionally + 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. -DEPENDENCIES + 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. - Catalyst - IO::Capture::Stdout; +SEE ALSO + Gitalist::Controller::Root -COPYRIGHT AND LICENCE + Gitalist::Git::Project -Copyright (C) 2009 Venda Ltd + Catalyst -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. +AUTHORS AND COPYRIGHT + Catalyst application: + (C) 2009 Venda Ltd and Dan Brook + (C) 2009, Tom Doran + (C) 2009, Zac Stevens + + Original gitweb.cgi from which this was derived: + (C) 2005-2006, Kay Sievers + (C) 2005, Christian Gierke + + Model based on http://github.com/rafl/gitweb + (C) 2008, Florian Ragwitz + +LICENSE + Licensed under GNU GPL v2 -gitweb.pm is based on the gitweb.perl from git-1.6.3.3 -(C) 2005-2006, Kay Sievers -(C) 2005, Christian Gierke