File	Date	Author	Commit
DB	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
build_questions	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
css	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
data	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
images	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
javascript	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
uploads	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
README.txt	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
about.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
add_user.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
blank.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
config.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
footer.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
functions.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
header.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
index.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
login.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
logout.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
members.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
question_builder.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
reset.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
reset2.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release
teacher_dashboard.php	2012-07-26	M. Freddie Dias	[67753f] Committing initial release

Read Me

##########################################################################################################################
# Copyright (c) 2012 Carngie Mellon University
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
# documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
# the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
# to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions 
# of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
# THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
##########################################################################################################################


INTRODUCTION
============

Thank you for downloading the Content Authoring Tool (CAT) for the OLPC English Literacy Tool. This is a PHP/mySQL 
based web application that can be used to create educational content that can then be downloaded in XML format and 
used in the OLPC English Literacy Tool (also released as a separate open source package). This software was 
originally created as part of the iSTEP 2011 internship program in Uruguay. For more information about the 
iSTEP 2011 internship please visit http://istep2011.techbridgeworld.org. If you have questions about this 
release or about the internship please contact <info@techbridgeworld.org> or visit http://techbridgeworld.org.


INSTALLATION
============

This software package requires a web server with PHP and mySQL. It has primarily been tested on a 
LAMP (Linux/Apache/mySQL/PHP) stack (running Ubuntu server edition) but it should be compatible 
with any web server running mySQL v5 (or greater) and PHP v4 or 5. To install this software on the 
server you first need to follow these steps:

1) Copy the entire contents of this folder to somewhere inside your web root folder (usually /var/www)

2) Create a new database and import the database structure stored in "DB/cat_db_structure.sql". This 
   can be done using the SQL command line (eg: mysql -u username -p password localhost DB-NAME < cat_db_structure.sql)
   or using a import tool (eg: phpMyAdmin import). Once the database is created you will need to make
   sure there is a mysql user account with access privileges to it -- I highly recommend *not* using
   the "root" mySQL account since you will need to save the password in the config.php file (see below)

3) Edit the "config.php" using a text editor and replace the values for $dbhost, $dbuser, $dbpass, and $dbname
   to reflect the new database created in step 2 and an account that has access to it (again I recommend not
   using the mySQL root account!). You will also want to modify the $email_from_address to something
   appropriate (see comments in "config.php" for more details)

4) Make sure that the web server process has write permissions for the "data" and "uploads" folders.
   (eg: on linux, chmod a+w data; chmod a+w uploads)

5) Navigate to the "index.php" page using a web browser, and click on the link to register a new user.
   Fill out the form to create a new user account for yourself, and then use that info to login to
   the system. If you are able to log in, the installation is complete!




LICENSE AND COPYING
===================

This software is distributed under the MIT open source license (http://opensource.org/licenses/MIT). Refer 
to the license text at the top of this file (and every source file) for details. The authors would love
to hear about any use of this software so please feel free to contact us at <info@techbridgeworld.org>
to let us know how this software is being used (but you are not obligated to do so).



CREDITS
=======

This software package makes use of two additional open source software packages that are included in this
distribution with some modifications.
1) JQuery javascript library (version 1.4.2)
     File: javascript/jquery-1.4.2.min.js
     Website: http://jquery.com/
     License: MIT or GPL

2) PHP SimpleAuth
     Files: config.php, functions.php, join.php, login.php, logout.php, members.php
     Website: http://simpleauth.munk.me.uk/
     License: No specific license was was specified for this module but the following is quoted from the 
	      README file in the distribution:
               "You may use and modify this package as you wish with the
                understanding that the code is very basic and only meant to be a
                startng block for your own project.  If you redistribute this code
                please retain the credit section at the head of each file."
     Note: Most of the files from this package have been modified from their original form
           to suit the needs of the CAT, but the original credit section has been retained
           in each file, as per the author's instructions.



FUTURE WORK
===========

As of this release, there are a number of features that we would love to add but still have not had the time or 
resources to put towards this. Some of the most important missing features are listed here:

 - Functionality to edit and delete questions in the database
 - User profile page that allows users to change their user account information (Name, school, password, etc)
 - Display more details about each question in the "create assignments" page
 - Confirmation code sent via email to verify email addresses before creating new user accounts