#!/usr/bin/perl

exec perldoc => $0;

=head1 NAME

Quelea - Administrative and surveillance tool for network administrators. 

=head1 INTRODUCTION

This project is not ready for production. None of the components below
is completed, but a lot of work have been done. Want to contribute?

=over 4

=item

Check out/fork the git-repo 

 git clone git://github.com/jhthorsen/quelea.git

=item

Read this C<README> file, and see which part you want to contribute.

=item

Make me write better documentation, so you can get get started
contributing.

=item

Let me know that you want to push commits to me, so I can add you to my
list of contributors.

=back

=head2 What do need you to know to contribute?

See the C<README> in the packages for more information.

=head1 DESCRIPTION

=head2 Quelea-Collector

This is the information gathering part of Quelea. This is either started
using L<Quelea-Server> or some sort of C<cron>-application.

The collector will populate the database using L<Quelea-Schema>, and may
also create data used in graphs using L<Quelea-Graph>.

=head2 Quelea-Graph

This module is used when either populating graph-databases, drawing
the actual graphs, or simply getting data from a graph-database.

=head2 Quelea-Schema

This is the database schema. It's based on L<DBIx::Class> to support a large
variety of database backends. Quelea is developeped using a MySQL database,
but no (or minor) changes is needed for either Postgres, sqlite or any other
well known database.

=head2 Quelea-Server

The Quelea-Server is the backend of Quelea. It currently handles these tasks:

=over 4

=item Collector

This is basically a cron-replacement, but it also provides locking and a
better control of your L<Quelea-Collector> instances.

=item DHCPd

To provide a full-featured Quelea-integration, you need to start the
C<ISC DHCPd> from inside Quelea. This is so it can serve the correct
boot-files, using L<TFTPd>

=item HTTPd

L<HTTPd> provides a JSON interface to a Quelea frontend, to serve information
not available from a database.

=item Instant

This will collect instant/live information.

=item TFTPd

Quelea-Server also have a builtin TFTP server, that can serve dynamic
boot-files.

=back

=head2 Quelea-Utils

This package contains modules and code, that does not fit into any of the
other packages.

=head2 Quelea-Web

This is the frontend for Quelea. It is very much possible to make a GTK,
QT or another web-based frontend for Quelea, but this is the default and
currently offisial frontend. It's web-based and tested in Firefox, Opera
and Internet Explorer.

=head1 GETTING STARTED

 $ cd path/to/quelea-git-repo
 $ source Quelea-Utils/bin/environment.sh
 $ sh install-deps.sh

C<environment.sh> will set up C<PATH> and C<PERL5LIB>, so you can test the
development edition of Quelea.

C<install-deps.sh> will install all dependencies. You might have to run this
as root, unless you have set up environment using L<local::lib>.

=head1 AUTHOR

Jan Henning Thorsen

=cut