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

[pygrader.git] / README

diff --git a/README b/README
index 43101f690f8f36b281bf735bdfc1168de40eb2e2..f3858f3117fa9d207cd2ac4128081e81c909777b 100644 (file)
--- a/README
+++ b/README
@@ -26,6 +26,9 @@ Dependencies
 ``pygrader`` is a simple package.  The only external dependency
 outside the Python 3 standard library is my `pgp-mime`_ package.
 
+If you are developing ``pygrader``, you can use `update-copyright`_ to
+keep the copyright blurbs up to date.
+
 Installing by hand
 ------------------
 
@@ -76,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
@@ -95,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
@@ -124,14 +141,17 @@ encrypt messages to that person and sign messages from that person
 with PGP_.  It will also be used to authenticate ownership of incoming
 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 ``pgp-fingerprint`` option is used when verifying
-that signed emails are signed by the appropriate person.  You can
-extract the fingerprint for the PGP key using GnuPG::
+their keychain.
+
+The ``course.robot`` option defines a dummy person used to sign
+automatically generated emails (e.g. responses to mailpipe-processed
+submissions).
 
-  $ gpg --fingerprint 4332B6E3
-  pub   2048R/4332B6E3 2012-03-21
-        Key fingerprint = B2ED BE0E 771A 4B87 08DD  16A7 511A EDA6 4332 B6E3
-  uid                  pgp-mime-test (http://blog.tremily.us/posts/pgp-mime/) <pgp-mime@invalid.com>
+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
 ----------------------
@@ -179,14 +199,14 @@ Author
 ======
 
 W. Trevor King
-wking@drexel.edu
+wking@tremily.us
 
 Related work
 ============
 
-For a similar project, see `Alex Heitzmann pygrade`_, which keeps the
-grade history in a single log file and provides more support for using
-graphical interfaces.
+For a similar project, see `Alex Heitzmann's pygrade`_, which keeps
+the grade history in a single log file and provides more support for
+using graphical interfaces.
 
 
 .. _PGP: http://en.wikipedia.org/wiki/Pretty_Good_Privacy
@@ -194,6 +214,7 @@ graphical interfaces.
 .. _layman: http://layman.sourceforge.net/
 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
 .. _pgp-mime: http://blog.tremily.us/posts/pgp-mime/
+.. _update-copyright: http://blog.tremily.us/posts/update-copyright/
 .. _Git: http://git-scm.com/
 .. _homepage: http://blog.tremily.us/posts/pygrader/
 .. _SMTP: http://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol