Started to fill out docs and sorted out license info.
[catagits/Gitalist.git] / README
1 NAME
2     Gitalist - Transitional project to convert gitweb.cgi to a Catalyst app
3
4 SYNOPSIS
5         script/gitalist_server.pl
6
7 INSTALL
8     As Gitalist follows the usual Perl module format the usual approach for
9     installation should work e.g
10
11       perl Makefile.PL
12       make
13       make test
14       make install
15
16     If you're running a git checkout of Gitalist then you'll additionally
17     need the author modules. *NB: As no distribution exists one will
18     presently need the author modules*.
19
20 DESCRIPTION
21     Gitalist is a web frontend for git repositories based on gitweb.cgi and
22     backed by Catalyst. It doesn't yet have the full functionality of
23     gitweb.cgi but it does have a few small additions at this stage.
24
25   History
26     This project started off as an attempt to port gitweb.cgi to a Catalyst
27     app in a piecemeal fashion. As it turns out, thanks largely to Florian
28     Ragwitz's earlier effort, it was easier to use gitweb.cgi as a template
29     for building a new Catalyst application.
30
31 SEE ALSO
32     Gitalist::Controller::Root
33
34     Gitalist::Git::Project
35
36     Catalyst
37
38 AUTHORS AND COPYRIGHT
39       Catalyst application:
40         (C) 2009 Venda Ltd and Dan Brook <broq@cpan.org>
41         (C) 2009, Tom Doran <bobtfish@bobtfish.net>
42         (C) 2009, Zac Stevens <zts@cryptocracy.com>
43
44       Original gitweb.cgi from which this was derived:
45         (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
46         (C) 2005, Christian Gierke
47
48       Model based on http://github.com/rafl/gitweb
49         (C) 2008, Florian Ragwitz
50
51 LICENSE
52     Licensed under GNU GPL v2
53