Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rwxr-xr-xREADME66
1 files changed, 66 insertions, 0 deletions
diff --git a/README b/README
new file mode 100755
index 0000000..7eb9c6c
--- /dev/null
+++ b/README
@@ -0,0 +1,66 @@
+==============================================================
+
+= = = = = = = = = = Karma Read Me = = = = = = = = = = =
+
+==============================================================
+
+Karma is subject to the terms detailed in the license
+agreement accompanying it.
+
+This Read Me file contains information about system
+requirements and installation instructions
+
+For more info on karma, start at http://www.karmaeducation.org .
+Most of the documentation is at http://wiki.sugarlabs.org/go/Karma
+
+To submit bugs
+or other feedback, go to http://www.launchpad.net/karma
+
+Karma is a subproject of SugarLabs http://www.sugarlabs.org
+
+The API documentation is available at
+http://karma.sugarlabs.org/docs/jsdocs/
+
+==============================================================
+
+ Getting karma
+
+==============================================================
+
+git clone git://git.sugarlabs.org/karma/mainline.git
+
+
+==============================================================
+
+ System Requirements
+
+==============================================================
+
+Running karma lessons requires an html5-capable web browser.
+
+It has only been tested thus far with with firefox 3.5 and
+Google Chrome.
+
+Running the karma utility script requires java v1.5 or greater
+
+==============================================================
+
+ Installation Instructions
+
+==============================================================
+
+
+
+==============================================================
+
+ Miscellaneous
+
+==============================================================
+
+
+
+Creating The First Translation Template
+------------------------------------
+run the setup.sh script in the utils/ directory
+
+./karma --gettext html_file.html js_file.js your_lesson_name.pot \ No newline at end of file