README

   1 NAME
   2     Gitalist - A modern git web viewer
   3
   4 SYNOPSIS
   5         script/gitalist_server.pl --repo_dir /home/me/code/git
   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     or
  17
  18       cpan -i Gitalist
  19
  20     You can also check gitalist out from git and run it, in this case you'll
  21     additionally need the author modules, but no configuration will be
  22     needed as it will default to looking for repositories the directory
  23     above the checkout.
  24
  25 DESCRIPTION
  26     Gitalist is a web frontend for git repositories based on gitweb.cgi and
  27     backed by Catalyst.
  28
  29   History
  30     This project started off as an attempt to port gitweb.cgi to a Catalyst
  31     app in a piecemeal fashion. As it turns out, thanks largely to Florian
  32     Ragwitz's earlier effort, it was easier to use gitweb.cgi as a template
  33     for building a new Catalyst application.
  34
  35 CONFIGURATION
  36     Gitalist can be supplied with a config file by setting the
  37     "GITALIST_CONFIG" environment variable to point to a configuration file.
  38
  39     A default configuration is installed along with gitalist, which is
  40     complete except for a repository directory. You can get a copy of this
  41     configuration by running:
  42
  43       cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
  44
  45     adding a repos_dir path and then setting "GITALIST_CONFIG".
  46
  47     Alternatively, if you only want to set a repository directory and are
  48     otherwise happy with the default configuration, then you can set the
  49     "GITALIST_REPOS_DIR" environment variable, or pass the "--repos_dir"
  50     flag to any of the scripts.
  51
  52     The "GITALIST_REPOS_DIR" environment variable will override the
  53     repository directory set in configuration, and will itself be overridden
  54     by he "--repos_dir" flag.
  55
  56 SEE ALSO
  57     Gitalist::Controller::Root
  58
  59     Gitalist::Git::Project
  60
  61     Catalyst
  62
  63 AUTHORS AND COPYRIGHT
  64       Catalyst application:
  65         (C) 2009 Venda Ltd and Dan Brook <broq@cpan.org>
  66         (C) 2009, Tom Doran <bobtfish@bobtfish.net>
  67         (C) 2009, Zac Stevens <zts@cryptocracy.com>
  68
  69       Original gitweb.cgi from which this was derived:
  70         (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
  71         (C) 2005, Christian Gierke
  72
  73       Model based on http://github.com/rafl/gitweb
  74         (C) 2008, Florian Ragwitz
  75
  76 LICENSE
  77     Licensed under GNU GPL v2
  78