Updated docs to reference new check_config_syntax script
[eq/.git] / doc / install.txt
index c8c5d6b17f3e4bec34bbbd7f186627d36ea861c1..eb2181e0374fc611ebdcf4d53ab6791d4faa4132 100644 (file)
@@ -13,10 +13,10 @@ Getting and Installing
 Downloading
 
    Can be downloaded from:
-   https://eq.pippins.net/eq.tar
+   https://eq.pippins.net/eq.zip
 
    It can also be obtained via the GIT revision control system by pulling from here:
-   http://git.pippins.net/eq/
+   http://git.pippins.net/eq/.git
 
 Installing
 
@@ -29,16 +29,24 @@ Installing
       need to assign this app to the users you want to have be able to use it.
       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
-   5) A graphical representation of the mysql schema used by this application can 
+   4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately. 
+      Check for syntax errors by running eq/bin/check_config_syntax
+   5) Copy the setup/eq_config to setup/eq_config.local and change the values in .local appropriately.
+      Make sure you update the path locations for your specific installation locations: 
+      upload_target_path & application_path
+      Check for syntax errors by running eq/bin/check_config_syntax
+   6) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
+      to check for any missing perl library dependencies and mysql connection. 
+      Just run them without command line args.
+      Install the right perl modules until the scripts run without any errors.
+   7) 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
+   8) 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.
+   9) 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.
+  10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
 
 Requirements