Improved documentation comments across multiple applications.
[eq/.git] / doc / install.txt
index 10ae9feb00df556f4d9da147ba98e2fdcf5cd08d..c8c5d6b17f3e4bec34bbbd7f186627d36ea861c1 100644 (file)
@@ -3,30 +3,42 @@ Elders Quorum Installation Guide
 
 Alan Pippin <apippin@pippins.net>
 
-   v1.0, 19 May 2005
+   v1.0, 05 Jan 2008
    
    Steps for installing Elders Quroum app
-     _________________________________________________________________
+   _________________________________________________________________
    
 Getting and Installing
 
 Downloading
 
-   Can be downloaded from some url.
-     _________________________________________________________________
-   
+   Can be downloaded from:
+   https://eq.pippins.net/eq.tar
+
+   It can also be obtained via the GIT revision control system by pulling from here:
+   http://git.pippins.net/eq/
+
 Installing
 
-   1) Setup the mysql table structures for the EQ application
-      cd eq/setup/ and run mysql -u <dbuser> -p <dbpass> < eq.sql
-   2) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
+   1) Download the eq.tar file and extract it or GIT pull the archive into 
+      your base phpgroupware directory (like /usr/share/phpgroupware/).
+   2) Setup the mysql table structures for the EQ application:
+      mysql -u <dbuser> -p <dbpass> < eq/sql/eq.sql
+   3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
       The setup prog will autodetect this application. From there you will 
       need to assign this app to the users you want to have be able to use it.
-   3) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
-      Make sure you update the path locations for:
+      Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
+      Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
+   4) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
+      Make sure you update the path locations for your specific:
       upload_target_path & script_path
-   4) A graphical representation of the mysql schema used by this application can 
+   5) A graphical representation of the mysql schema used by this application can 
       be found here: eq/sql/eq.jpg
+   6) Click on the Admin tool in the EQ app to import your initial set of ward data
+      obtained from MLS into the EQ application.
+   7) Click on the Admin tool and update the EQ Presidency Table appropriately.
+      The most important thing at this point is to get your district leaders added 
+      for each district you have in your quorum.
 
 Requirements