File	Date	Author	Commit
activity	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
dist	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
icons	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
Database.py	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
OCTActivity.py	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
Questions.py	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
README.txt	2012-07-26	M. Freddie Dias	[a24be0] Committing initial release
setup.py	2012-07-26	M. Freddie Dias	[a24be0] 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 OLPC English Literacy Tool. This is a Python app written specifically to run in the sugar
operating system on OLPC XO 1.5 laptops. The software provides an interface for students to complete assignments related
to English literacy, which are automatically graded in real time.  It is meant to use XML content files created by the 
Content Authoring Tool (a web based tool distributed as a separate open source package). This software also allows students 
to export their completed assignments to a USB drive (in XML format) to share with their teachers for further feedback.
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
============

All of these files are expected to be in a directory called OCTActivity.activity in the home directory (~) of the OLPC. 
You might need to change the permissions on the file "setup.py" to allow execution (e.g. chmod a+x setup.py).

To create an activity on the home screen for testing:
./setup.py dev

To create a .xo file for distribution: 
./setup.py dist_xo
The .xo file will be located in "dist" subfolder inside "OCTActivity.activity"



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).



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:

- Adding support for listening comprehension question types (using mp3 or wav audio files)
- Modifying python code to allow changing background colors and font colors to make the UI more vibrant
- Providing an interface for teachers to view completed assignments and track student progress