[catagits/Gitalist.git] / README

Gitalist - a transitional project to convert gitweb.cgi to a Catalyst app.

The idea behind this project is to move gitweb.cgi away from a single
monolithic CGI script and into a modern Catalyst app. Fortunately this is not
as daunting as it might seem at first as gitweb.cgi follows an MVC type
structure. Once gitweb.cgi has been suitably Catalysed then it can move from
being "this was once gitweb.cgi" to a project of its own (hence the
"transitional" in the description).

As it stands Gitalist is very much in its infancy and hasn't got far
beyond a layout template and a single controller.

USAGE

To get Gitalist up and running just set projectroot & repo_dir (one in
the same unfortunately at this point) in gitalist.conf to point to the
directory that contains your repositories. With that done just run:

  perl script/gitalist_server.pl

DEPENDENCIES

  Catalyst
  IO::Capture::Stdout
  Catalyst::View::ContentNegotiation::XHTML
  Template::Plugin::Cycle
  DateTime
  Path::Class
  File::Find::Rule;
  DateTime::Format::Mail
  File::Stat::ModeString
  List::MoreUtils
  MooseX::Types::Common
  # Probably others ...

COPYRIGHT AND LICENCE

Copyright (C) 2009 Venda Ltd

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.

gitweb.pm is based on the gitweb.perl from git-1.6.3.3
(C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
(C) 2005, Christian Gierke
Commit	Line	Data
4534cd82	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
86382b95	7	being "this was once gitweb.cgi" to a project of its own (hence the
4534cd82	8	"transitional" in the description).
	9
	10	As it stands Gitalist is very much in its infancy and hasn't got far
5dbe718c	11	beyond a layout template and a single controller.
4534cd82	12
8927fe98	13	USAGE
8927fe98	14
e99c6ee1	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:
8927fe98	18
	19	perl script/gitalist_server.pl
	20
4534cd82	21	DEPENDENCIES
	22
	23	Catalyst
5dbe718c	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
77793bf2	33	MooseX::Types::Common
5dbe718c	34	# Probably others ...
4534cd82	35
	36	COPYRIGHT AND LICENCE
	37
	38	Copyright (C) 2009 Venda Ltd
	39
	40	This library is free software; you can redistribute it and/or modify
	41	it under the same terms as Perl itself, either Perl version 5.8.8 or,
	42	at your option, any later version of Perl 5 you may have available.
93d71695	43
569659f2	44	gitweb.pm is based on the gitweb.perl from git-1.6.3.3
93d71695	45	(C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
93d71695	46	(C) 2005, Christian Gierke