ackerTodo v4.0
==============

* If you are upgrading from a previous version of ackerTodo, please
   read the UPGRADE file to make sure you don't need to do anything
   special.

Create The Database Automatically
---------------------------------
1.) Copy the src directory where it can be accessed by your webserver.
    cp -a src /var/www/ackertodo

2.) Edit the $host, $user, $pass, $database and $table_prefix variables in 
      config/config.inc.php with the information used to connect to your 
      mysql server.

3.) Point your browser to the setup script where you've copied the src 
      directory. (ex. http://www.your-domain.com/ackertodo/setup/setup.php).

4.) Follow the instructions in the setup script until you see 
      "Set is complete!", then point your browser to the where you've
      copied the src directory. (ex. http://www.your-domain.com/ackertodo/).
      The default admin user is 'admin', password 'admin'.
      
5.) Remove the setup directory.

6.) Begin adding tasks!
 

Create The Database Manually
----------------------------
1.) Create a mysql database to store the data.
    mysqladmin -u <user> -p create <database>

2.) Create the tables with the 'ackertodo.sql' script in src/setup.
    mysql -u <user> -p <database> < src/setup/ackertodo.sql

3.) Copy the src directory where it can be accessed by your webserver.
    cp -a src /var/www/ackertodo
 
4.) Edit the $host, $user, $pass, and $database variables in 
      config/config.inc.php with the information used to connect to your 
      mysql server.

5.) Remove the setup directory.

6.) Point your browser to where you've copied the src directory.
      (ex. http://www.your-domain.com/ackertodo/).
      The default admin user is 'admin', password 'admin'.

7.) Begin adding tasks!


Access Keys
-----------
ackerTodo comes default with access keys enabled for the following...

Access Key: s  -> Task List
Access Key: n  -> New Task
Access Key: c  -> Calendar
Access Key: m  -> Admin Menu
Access Key: l  -> Logout

Use ALT + Access Key under windows and CTRL + Access Key on a Mac.


Modules
-------
New with ackerTodo v2.0, you can create somewhat useful modules. I've
included two modules (AIM Notification and File Uploader) which you can
look at to see how you should be coding your modules. I've also added a
test module that has all the functions supported so far and a brief
description of when they're used. If you have improvements, comments, or
suggestions for the module system, PLEASE let me know. This is my first
shot at this, so feedback is much appreciated, thanks!


Email Notification (Optional)
-----------------------------
I've also written a php cli script that can be ran as a cron job (see
your cron man pages for information on how to set that up) and will
email people their task the day the task is due. Just edit the
'email.php' script with your information, and setup a cron job like
mine:     5 0 * * *  /usr/bin/php PATH_TO_SCRIPT/email.php
The above cron job will run the script at 00:05 each day. At that time 
an email will be sent to users with tasks due on that day.



* To see a live working demo, visit http://zoidian.com/ackertodo/ login with
  a username and password of demo.

* We need themers and translators. If you speak another language
  fluently, please grab the english.inc language file and translate it
  to what you know. Just rename it to <your_language>.inc and send it to
  hensleyrob@nku.edu. As for themers, just take a loot at the
  default.css theme and get to work! :)

* LANGUAGE FILES! -> As of ackerTodo v1.60, the only complete language
  file is the English one. I chose to include the incomplete one's in an
  actual release to try and motivate someone who speaks that language to
  clean it up and finish it. Hopefully some people will actually take
  the initiative to do so.

--
Comments, questions, and suggestions can be directed to
Rob Hensley <hensleyrob@nku.edu> http://ackertodo.sourceforge.net

