Read Me

/**
 * README
 *  
 * Copyright © 2010 Tom Kaczocha
 * 
 * This file is part of the Linux Alarm Clock
 * 
 * Linux Alarm Clock is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Linux Alarm Clock is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Linux Alarm Clock.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */
 
========================================================================
			Linux Alarm Clock README
========================================================================

Linux Alarm Clock Project

The Linux Alarm Clock will be divided into two layers, with the Shell/GUI
modules operating in parallel. Both modules in Layer 2 will utilise the
Library in Layer 1 for its operation.



              |-------------|        |-------------|
              |             |        |             |
Layer 2       |    Shell    |        |     GUI     |
              |             |        |             |
              |-------------|        |-------------|
                     |                       |
              |------------------------------------|
              |                                    |
Layer 1       |             Library                |
              |                                    |
              |------------------------------------|


The Library (Layer 1), is to only contain functions utilised by both the
shell and gui modules.

Unique functionality to each module is to be stored in individual libs in
Layer 2.

Ultimately, the project will install the GUI version by default. Specifying
(--shell, or something similar) will install the Shell version instead.

The project intends to use the QT Library in C++ for the GUI.


The project will use GNU Auto Tools for compiling makefiles.

The project must comply with GNU Standards.


========================================================================
Report bugs to <freedomdeveloper@yahoo.com
========================================================================