converted readme to pandoc markdwn

1 files changed, 34 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad5eb8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+
+# Typical work flow for a class creation
+
+* Create a class database with CreateCourseGradeBook.tcl command.
+```
+./CreateCourseGradeBook.tcl 2015_Spring_Phys476 eemikh@wm.edu  2015 Spring "Physics 476 - Modern Astrophysics" Eugeniy Mikhailov
+```
+* Prepare comma separated list of students with their names, ID, emails, and CRN.
+  The best way to do it, is to save a "Summary class web page" from the banner and process it with banner2csv.pl. This will automatically extract required information.
+```
+./banner2csv.pl banner_summary_page.html > tt.csv
+```
+
+    If you make such comma separate list yourself note that:  
+    1. ID is optional. But if we have ID, we can show a student photo
+    2. CRN is optional. It is intended to separate graders permissions across sections. But it is not implemented. 
+
+* Now we ready to populate the class database
+```
+./csv2GradeBook.tcl 2015_Spring_Phys476 tt.csv
+```
+* Upload the resulting database file to the cgi directory and fix its permissions
+* Access the class database via web interface and add TAs/graders
+   
+ 
+
+# Requirements/Dependencies
+
+This set  of script requires  at least version  tcl8.5, since it  uses List
+containment and negated list containment (in ni) expression operators.
+
+It need external 'mail' command for proper operation of password resetting code
+
+You will need libsqlite3-tcl as well.