Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authordjm <djm@38b22f21-9aea-0310-abfc-843a9883df58>2005-02-08 01:17:40 (GMT)
committer djm <djm@38b22f21-9aea-0310-abfc-843a9883df58>2005-02-08 01:17:40 (GMT)
commit4b1c5dc600a9ca7e309bff2720e307d2bc9c47e0 (patch)
tree13876bfea0bbd9ffea69043788531553bfaa3b69 /README
parenta20975281e2337f1f7b0505f50a0f8524d5ea3e1 (diff)
Created README for 1st release
git-svn-id: https://exe.svn.sourceforge.net/svnroot/exe/trunk@225 38b22f21-9aea-0310-abfc-843a9883df58
Diffstat (limited to 'README')
-rw-r--r--README92
1 files changed, 79 insertions, 13 deletions
diff --git a/README b/README
index ff00c75..0eaba1b 100644
--- a/README
+++ b/README
@@ -1,23 +1,89 @@
-Welcome to eXe: eLearning XML editor
+=========================================
+ eXe: The eLearning XML editor
+=========================================
-Unzip the package
-Run server.exe
+===========================================================================
+Copyright 2004-2005, University of Auckland
+All rights reserved, see COPYING for details.
+
+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 2 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, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+===========================================================================
+
+SUPPORT
+=======
+This is an early (the first!) release of the eXe project. It is intended
+to elicit feedback from the user community. We expect file formats will
+change. It would be a bad idea to invest a lot of time in creating a
+large package with this release. This release is just for playing.
+
+If you have any problems or have any feedback please post them on the Eduforge
+forum https://eduforge.org/forum/forum.php?forum_id=284 or email them to
+d.moore@auckland.ac.nz.
+
+REQUIREMENTS
+============
+The interface for eXe requires the Mozilla Firefox browser. (This can be
+downloaded from http://www.mozilla.org/products/firefox). You do not
+need to set Firefox as your default browser (but it doesn't hurt ;-) ).
+
+WINDOWS
+=======
+
+INSTALLATION
+------------
+- Download exe-0.1.223.msi and double click it then follow the instructions.
+- You will be asked what directory to install eXe in. The default will normally
+ be fine.
+- The installer will create an eXe icon on the desktop and a menu-item under
+ "All Programs".
+
+
+RUNNING
+-------
+Double click on the shortcut on the desktop to launch eXe.
+
+A window with "Welcome to eXe: the eLearning XML editor" and a Firefox browser
+will start. To close eXe you will need to exit both of these. Remember to
+save your content before exiting.
The first time you run you may get asked if you want to allow eXe
-to access the internet. eXe does NOT require access to the internet,
+to access the Internet. eXe does NOT require access to the Internet,
just select the option to block its access.
-If Firefox is not your default browser, open Firefox and load the
-URL http://localhost:8081.
+Packages are saved to your "My Documents" folder with the .elp extension
+(eXe eLearning Package).
+
+
+LINUX
+=====
+These instructions are tailored for Windows users. eXe does work on Linux
+as well, but does not have an automated installer. Linux users will need
+to untar the source files and have Python 2.3.4 (http://python.org) and
+Twisted 1.3.0 (http://twistedmatrix.com) installed.
+
-This is a pre-release (0.1.183). The interface will be changing.
-We only support Firefox for the browser. This will not render
-well in Internet Explorer. We have limited functionality.
-There are bugs.
+KNOWN BUGS
+==========
+- I you have changed content on the Authoring page and change to another page
+ without clicking on a Done (green tick) the changes will be lost.
+- I you have changed the fields on the Properties page and change to another page
+ without clicking on a Done the changes will be lost.
+- The Outline Pane in the Control Panel has problems with large trees - we're
+ working on it! If you know XUL please contact us!
Have a nice day!
-2005-02-01 DJM
-If you have problems post on the wiki http://exe.cfdl.auckland.ac.nz
-or email me djm@software.net.nz.
+2005-02-08 DJM