Document course.robot and assignment.submittable in the README.

diff --git a/README b/README
index af573b3447e2b02dc2147ecd09cf03f6bb1e9f37..f3858f3117fa9d207cd2ac4128081e81c909777b 100644 (file)
--- a/README
+++ b/README
@@ -79,6 +79,7 @@ the course directory::
 
   $ cat test/course.conf
   [course]
 
   $ cat test/course.conf
   [course]

+  robot: Robot101

   assignments: Attendance 1, Attendance 2, Attendance 3, Attendance 4,
     Attendance 5, Attendance 6, Attendance 7, Attendance 8, Attendance 9,
     Assignment 1, Assignment 2, Exam 1, Exam 2
   assignments: Attendance 1, Attendance 2, Attendance 3, Attendance 4,
     Attendance 5, Attendance 6, Attendance 7, Attendance 8, Attendance 9,
     Assignment 1, Assignment 2, Exam 1, Exam 2


@@ -98,11 +99,24 @@ the course directory::
 
   …
 
 
   …
 

+  [Assignment 1]
+  points: 10
+  weight: 0.4/2
+  due: 2011-10-10
+  submittable: yes
+
+  …
+

   [Exam 2]
   points: 10
   weight: 0.4/2
   due: 2011-10-17
 
   [Exam 2]
   points: 10
   weight: 0.4/2
   due: 2011-10-17
 

+  [Robot101]
+  nickname: phys101 robot
+  emails: phys101@tower.edu
+  pgp-key: 4332B6E3
+

   [Gandalf]
   nickname: G-Man
   emails: g@grey.edu
   [Gandalf]
   nickname: G-Man
   emails: g@grey.edu


@@ -129,6 +143,16 @@ emails.  You'll need to have GnuPG_ on your local host for this to
 work, and the user running pygrader should have the associated keys in
 their keychain.
 
 work, and the user running pygrader should have the associated keys in
 their keychain.
 

+The ``course.robot`` option defines a dummy person used to sign
+automatically generated emails (e.g. responses to mailpipe-processed
+submissions).
+
+The ``submittable`` option marks assignments that accept direct
+submission from students (e.g. homeworks).  You probably don't want to
+set this option for attendance, since it would allow students to mark
+themselves as having attended a class.  ``submittable`` default to
+``False``.
+

 Processing submissions
 ----------------------
 
 Processing submissions
 ----------------------