Remove the massive chunk of crud to do application/xhtml+xml detection and replace...
[catagits/Gitalist.git] / README
CommitLineData
4534cd82 1Gitalist - a transitional project to convert gitweb.cgi to a Catalyst app.
2
3The idea behind this project is to move gitweb.cgi away from a single
4monolithic CGI script and into a modern Catalyst app. Fortunately this is not
5as daunting as it might seem at first as gitweb.cgi follows an MVC type
6structure. Once gitweb.cgi has been suitably Catalysed then it can move from
7being a "this was once gitweb.cgi" to a project of its own (hence the
8"transitional" in the description).
9
10As it stands Gitalist is very much in its infancy and hasn't got far
11beyond a layout template and a single controller. Probably the next step is
12moving an existing action into a new Catalyst action and lay down the code
13to make porting further actions, or writing new ones, as simple as possible.
14After that provide a model based on one of the git modules, either the Git.pm
15that comes with git or Git::PurePerl, and deprecate or port the existing
16gitweb.cgi functions.
17
8927fe98 18USAGE
19
20To get Gitalist up and running just set $projectroot in gitweb.conf to point
569659f2 21to the directory that contains your repositories. With that done just run:
8927fe98 22
23 perl script/gitalist_server.pl
24
4534cd82 25DEPENDENCIES
26
27 Catalyst
28 IO::Capture::Stdout;
29
30COPYRIGHT AND LICENCE
31
32Copyright (C) 2009 Venda Ltd
33
34This library is free software; you can redistribute it and/or modify
35it under the same terms as Perl itself, either Perl version 5.8.8 or,
36at your option, any later version of Perl 5 you may have available.
93d71695 37
569659f2 38gitweb.pm is based on the gitweb.perl from git-1.6.3.3
93d71695 39(C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
40(C) 2005, Christian Gierke