removed mods directory from the ATutor codebase
[atutor.git] / mods / mahara / README
diff --git a/mods/mahara/README b/mods/mahara/README
deleted file mode 100644 (file)
index b9e03ab..0000000
+++ /dev/null
@@ -1,82 +0,0 @@
-====================================\r
-Mahara ePortfolio Integration Module\r
-\r
-     by: Boon-Hau Teh\r
-====================================\r
-\r
-\r
-Overview\r
-----------------\r
-This is a simple Mahara integration module for ATutor.\r
-\r
-   "Mahara is an open source e-portfolio, weblog, resume builder\r
-    and social networking system, connecting users and creating\r
-    online learner communities. Mahara is designed to provide users\r
-    with the tools to demonstrate their life-long learning, skills\r
-    and development over time to selected audiences."\r
-\r
-\r
-Requirements\r
-----------------\r
-* ATutor version 1.6 or above\r
-* Mahara 1.0.2\r
-\r
-\r
-Installing\r
-----------------\r
-1. Install ATutor and Mahara on the same server (see their\r
-   respective installation documents).\r
-\r
-2. Copy all Mahara module files to /mods/mahara in Atutor.\r
-\r
-3. As an administrator in ATutor, install and enable the module.\r
-\r
-4. A link to 'ePortfolio' should now appear in the navigation menu.\r
-   Still logged in as an administrator, enter full the path to the\r
-   Mahara installation.\r
-\r
-       example on Windows system:\r
-            C:\webroot\mahara\\r
-\r
-       example on Linux system:\r
-            /usr/local/apache/htdocs/mahara/\r
-\r
-\r
-Using ePortfolio\r
-----------------\r
-Once logged into ATutor, a regular user can access his/her\r
-ePortfolio through the main menu or Home page.  The ePortfolio\r
-will appear on the page in ATutor as an embedded iframe.  The user\r
-has the option of clicking on a button, which closes the iframe and\r
-opens the ePortfolio in a new window/tab of the browser.\r
-\r
-If a user's account on ATutor is deleted, the user's ePortfolio\r
-account on Mahara still remains active.  If the user wishes to\r
-continue accessing Mahara, the user should be able to retrieve\r
-the password by entering his/her E-mail (the same E-mail that was\r
-registered in ATutor) through the "Password Reminder" feature of\r
-Mahara.  Note that the "Password Reminder" feature is provided\r
-by Mahara 1.0.2 and is external to this module.\r
-\r
-\r
-\r
-Developer's Note\r
-----------------\r
-This module does not make use of the single-sign-on feature via\r
-XMLRPC provided by Mahara. Instead, it integrates Mahara into\r
-ATutor by directly calling necessary functions found in Mahara.\r
-Therefore, this module may not work in other versions of Mahara if\r
-there are any noticeable changes made to these required functions.\r
-\r
-This module is intended for Mahara to run as an integrated part of\r
-ATutor, and not as a standalone program.  Single-sign-on through\r
-ATutor is implemented by storing login information for Mahara in the\r
-ATutor database.  When a user accesses the ePortfolio for the first\r
-time, the user is automatically registered into Mahara with a new\r
-account.  User details get copied over from ATutor and a password\r
-for Mahara is automatically generated.  The username and password\r
-get stored with ATutor and used whenever accessing Mahara\r
-(through Mahara's login script).  In the event that the username\r
-and password is lost from the database, the module can still find\r
-the user (by username) on the Mahara database, generate a new\r
-password, and re-save the login information in ATutor.\r