==========
| README |
==========

About ProjectLK
===============
ProjectLK is a web based open source application for managing digital text based flash cards with the focus on vocabulary.
It's designed after the Leitner System [http://en.wikipedia.org/wiki/Leitner_System], but it also offers the possibility to review the cards in any way you want.
Additionally verbs can be listed in tables of conjugations and also be reviewed.
It uses MySQL, PHP and Javascript.

---

Demo
====
http://projectlk.ihdg.ch/home/
Click on "en" above to get an english version.

---

Browser Support
===============
Please report bugs in any of these browsers:
Mozilla Firefox - 3.6 or newer
Google Chrome
Opera - 10 or newer
Apple Safari - 4 or newer
Internet Explorer - 8 or newer

Partial Support:
ProjectLK is mostly usable in the following browsers, but may look ugly.
Please only report serious usability issues for these browsers:
Internet Explorer 7

known issues in IE7:
Some inputs cannot be submitted with the enter key. Use the tab key instead.

---

Release & Developer Version
===========================
There are 2 versions of this code. The first version, the developer version, provides all code and files in a readable and uncompressed format. In the release version the javascript part of the code is compressed with the closure compiler and unused .xcf image files are removed. Also the javascript compiler is removed. 
Both versions can be installed in the same way as described in INSTALL.txt.
In order to convert a developer version into a release version these steps must be followed:

1. copy everything into a seperate folder
2. inside that folder compile javascript by using the make command in the terminal.
3. delete the folder "compiler"
4. delete all uncompiled javascript files
5. delete all .xcf image files
6. inside config.php set release = 1 and debug = 0.
A more detailed description can be found in the wiki

Insallation
===========
see INSTALL.txt

---

Documentation
=============
Wiki: https://github.com/pascalfree/ProjectLK/wiki

---

Authors
=============
David Glenck - [email protected]
prototype.js : Sam Stephenson - http://prototypejs.org/
closure compiler : https://developers.google.com/closure/compiler/

---

License
=======
All parts of the code, except for those mentioned below, are licenced under the GNU GPL v3.

Copyright (C) 2012  David Glenck

    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 3 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 for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>

--
closure compiler:
In folder: /compiler/
Licence: Apache License, Version 2.0

--
prototype.js
In folder: /core/javascript/library/
Licence: MIT

---