f4294ca3efd16796cd5c6541c39a138fcb81393c
[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.
12
13 USAGE
14
15 To get Gitalist up and running just set projectroot & repo_dir (one in
16 the same unfortunately at this point) in gitalist.conf to point to the
17 directory that contains your repositories. With that done just run:
18
19   perl script/gitalist_server.pl
20
21 DEPENDENCIES
22
23   Catalyst
24   IO::Capture::Stdout
25   Catalyst::View::ContentNegotiation::XHTML
26   Template::Plugin::Cycle
27   DateTime
28   Path::Class
29   File::Find::Rule;
30   DateTime::Format::Mail
31   File::Stat::ModeString
32   List::MoreUtils
33   # Probably others ...
34
35 COPYRIGHT AND LICENCE
36
37 Copyright (C) 2009 Venda Ltd
38
39 This library is free software; you can redistribute it and/or modify
40 it under the same terms as Perl itself, either Perl version 5.8.8 or,
41 at your option, any later version of Perl 5 you may have available.
42
43 gitweb.pm is based on the gitweb.perl from git-1.6.3.3
44 (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
45 (C) 2005, Christian Gierke