################################################################################
##                                                                            ##
##                              ToDoList.php                                  ##
##                              ------------                                  ##
##                                                                            ##
################################################################################
$Id: README,v 1.5 2000/08/04 15:27:57 joersch Exp $


what is it?
-----------
"todo-list" is a set of PHP3 scripts that create a web-based list of things to
do.  Items can be added and removed, and are sorted by an assigned priority. 
Also it is possible to assign special tasks to another person and for example
to specify a due date. ToDoList is multilingual. Lots of unmentioned features.

"todo-list" was inspired by "todo", some CGI-Scripts, written by Marc
Bayerkohler and Joel Thomas. It was started, because I wanted to learn PHP3 and
really needed an easy to use todo-list.

This program 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 2 of the License, or (at your option) any later
version.
This program 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
<http://www.opensource.org/gpl-license.html> for more details. 

If you have any suggestions or wishes for future versions feel free to contact
me.

Have fun, Jrg Menke <jhm@gmx.net>


system requirements
-------------------
All you need is an PHP3-enabled web-server (Apache preferred) and mySQL. Other
databases will (maybe) be supported in the future.


How do I install?
-----------------
- put the .php3 files somewhere where they are accessible by the webserver
- create the database-tables (just run the "databasestructure.sql" in mysql)

  $ mysql -u DBUSER DBINSTANCE < databasestructure.sql

- Create the users for the ToDoList. Sorry, but at the moment this is only
  possible using the MySQL-Client directly. Enter

  INSERT INTO todo_users VALUES
  (NULL,'loginname','firstname','lastname','password');
  
  for every user you need. A testuser called John Smith with the username
  'testuser' and the password 'testpw' is created automaticly by the
  databasestructure.sql-Script.
- edit the "include/config.inc"-file to fit your needs.
- if you want to setup a cron-job to delete old, done, todos. For example like
  this one (everything in one line):

0 8 * * * mysql todo -u root -e "delete from todo_todos where
  to_days(now()) - to_days(date_changed) > 14 and prioritaet=4;"

  But remember: In my opinion it is always important to know what you did for
  example last week, or last month, or maybe last year. So be careful deleting
  data. You might miss it somewhen!

  
What might be implemented in the future / ToDo for the ToDoList.php?
--------------------------------------------------------------------
- A possibility to administrate the users easily.
- User-specific settings (language, colors, etc.)
- Rewrite the database-handling
- Better error-handling
- logging of activities in the list
- mail-notify if something changed on the list (partly implementet - untested!)
- user-manual
