Read Me

  PLEASE NOTE !!

  TimeOffMinder is free software. It 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 Affero General Public License for more details.


This file will provide an overview of the TimeOffMinder application and 
show you how to get started once the application has been installed. For
install instructions, please see the "INSTALL" file.

The TimeOffMinder application can be used at small, medium and large 
enterprise-sized organizations. Every organization will have employees and
every employee will need to have vacation, personal, floating, sick etc. time 
taken. Management in every organization will need to keep track of time off
taken by their employees. TimeOffMinder helps make this aspect of management
centralized, easier and efficient.

TimeOffMinder was designed with the typical management tree structure in 
mind. At the highest level (Root Level), you would have the President, 
Chairman or CEO. The people reporting directly to the President, Chairman 
or CEO will belong to the President, Chairman or CEO's Department or Group.

With the above in mind, we can start configuring the application. The 
following steps should get you started:

1. Log in with "admin" as login ID and "none" as password. Change the 
   password to the "admin" account by clicking on "admin" (not "Admin")
   and then clicking on "Reset Password". Log out and log back in with the
   new strong password.

2. The application comes with a "Root Level Group" already configured. The
   idea is to create a Department/Group for the President, Chairman or CEO
   and make that a child of the "Root Level Group". Before we do that, we 
   have to create an entry for the President, Chairman or CEO. We do that
   by clicking the "Admin" link and then clicking "Create new user" link.

3. The first step is to create an entry for the President, Chairman or CEO.
   You can have as many levels as you want under that. Once that is done,
   the President, Chairman or CEO can create direct his/her direct reports,
   departments/groups, assign managers to the departments/groups created 
   directly under him/her.  

   If you prefer, a Delegated Admin can be created for the President, Chairman 
   or CEO's department and he/she can perform all those functions.

4. In this manner, the hierarchy for the entire company/organization can
   be created.