Merge branch 'master' of github.com:deedydas/CISCEResults2013

README.textile

@@ -1,6 +1,23 @@
-CISCEResults2013
-================
+h1. ICSE and ISC Results 2013
 
-Scripts and Data about the ISC and ICSE results 2013 for all schools.
+It turns out that the "ICSE":http://www.cisce.org/icse_X.html and "ISC":http://www.cisce.org/isc_XII.html results aren't secured. Here are a bunch of scripts that help download the results, as well as include a comprehensive list of already downloaded results.
 
-h2. Overview
+h2. Setup
+
+After you clone the repository @CISCEResults2013@, navigate into @./ICSEResults13/@ or @./ISCResults13/@.
+
+h3. Single School Data Retrieval
+
+Run the following: ```./getISCforSchool 9282```to get the ISC results for school ID 9282. Remember, ISC school IDs range from @9001@ to @9793@. Or you can use ```./getICSEforSchool 4674``` to get ICSE results for school ID 4674. ICSE school IDs range from @4001@ to @5568@.
+
+h3. Range of Schools Data Retrieval
+
+Run the following: ```./getAllISC 9282 9300```to get the ISC results for all school IDs from 9282 to 9300. Remember, ISC school IDs range from @9001@ to @9793@. Or you can use ```./getAllICSE 4674 4700``` to get ICSE results for school IDs 4674 to 4700. ICSE school IDs range from @4001@ to @5568@.
+
+h2. Pre-fetched Results By School
+
+All the results have already been fetched and can be found at @./ICSEResults13/DataBySchool/@ or @./ISCEResults13/DataBySchool/@.
+
+h2. Pre-fetched Compilation of All Results
+
+All the pre-fetched results can be found at @./ICSEResults13/AllData/@ or @./ISCEResults13/AllData/@. The data is found in 3 files - a raw csv file, a comprehensive refined xlsx file and a csv file with incomplete results. @./ICSEResults13/AllData/AllCompleteResults.xlsx@