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