From: W. Trevor King <wking@tremily.us>
Date: Tue, 24 Apr 2012 21:16:25 +0000 (-0400)
Subject: Document course.robot and assignment.submittable in the README.
X-Git-Tag: v0.2~4
X-Git-Url: http://git.tremily.us/?p=pygrader.git;a=commitdiff_plain;h=c6910d2c7525493e55b0ba2432e3f1e18e4d236c

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

diff --git a/README b/README
index af573b3..f3858f3 100644
--- a/README
+++ b/README
@@ -79,6 +79,7 @@ the course directory::
 
   $ 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
@@ -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
 
+  [Robot101]
+  nickname: phys101 robot
+  emails: phys101@tower.edu
+  pgp-key: 4332B6E3
+
   [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.
 
+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
 ----------------------