From 7cd07d4a8fde45c9194c1c96223078740a2b65fb Mon Sep 17 00:00:00 2001 From: Ben Kurtovic Date: Mon, 21 Mar 2016 22:38:47 -0400 Subject: [PATCH] Update README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 8e719a8..e7ce601 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,30 @@ __kgrader__ is a code autograder, originally created by the course staff of Honors) at the University of Illinois to grade student homework submissions. It is written in Ruby. + +Installation +------------ + +Download kgrader over git: + + git clone https://github.com/earwig/kgrader.git kgrader + cd kgrader + +If you want to use UIUC-specific assignment specifications (requires special +permissions, but you have those if you want to grade our assignments, right?): + + git submodule update --init + +Usage +----- + +kgrader uses rake as its command-line interface. + +To do some basic housekeeping: + + rake clean + +To restore kgrader to its factory defaults (i.e., delete checked-out student +repos and any uncommitted grading attempts): + + rake clobber