Welcome to Helpdesk Registration System
---------------------------------------

CONTENTS
--------
  1: What is HRS?
  2: What do you need?
  3: How to install it?
  4: Bug reports/contributions
  5: Todo
  6: Contacting the authors
  
1: What is HRS?
---------------
HRS is a web-based intranet application for registration of your helpdesk
calls.

2: What do you need?
--------------------
At the server side:
  - linux ( freebsd might work, we haven't tried that )
  - webserver (preferrably Apache)
  - mySQL server (if you want to use another SQL server, that's fine,
                  but you'll have to recode half the program.
		  with the current structure the DB access functions are
		  scattered around the whole program (this will hopefully
		  change in the future ))

At the client side:
  - operating system ( whichever you like, can be linux, bsd, windows, os/2 )
  - A web browser with support for forms.
  
basically, that's it... ofcourse you will also need a C compiler system to
compile the sources.

3: How to install
-----------------
After unpacking the tarball you will find the following structure

hrs-x.x.x/db
  - this contains three files for creating the needed tables in the
    mysql database called 'HRS'
    
hrs-x.x.x/html
  - these files must be copied to a directory inside your webserver root.
  
hrs-x.x.x/src
  - the sources. these are split up to three directories:
hrs-x.x.x/src/include
  - this directory contains file(s) with functions used by the whole system.
hrs-x.x.x/src/incidents
hrs-x.x.x/src/users
  - the actual sources. before compiling please check the makefile for
    options and install-directories
    
4: Bug reports/contributions
----------------------------
At this moment the system is full of bugs and non-functional parts.
If you feel the need to write or rewrite a part of the program,
please mail the changes to us. We are very happy with contributions.
We will ofcourse add your name to the list of contributors/authors.
If you find a bug please don't hesitate to mail us about it.

5: Todo
-------
There are a lot of things that need to be done, so i'll only list the top 
priorities here:

- Translate the program itself to english. ( it is currently in dutch )
- complete the current functions
- enhance security
- add new functions

6: Contacting the authors
-------------------------
you can mail us at the following addresses:

Arnoud Edens (a.edens@hccnet.nl)       - code, readme, package, everything else
Gerben Versluis (gec@nl.scene.org)     - code, docs, everything else
Jeffrey Nelissen (jnelissen@zonnet.nl) - design, code
Evert Meurs (oxygene@casema.net)       - design

