diff --git a/TUTORIAL.md b/TUTORIAL.md index af329ea..6d0c75a 100644 --- a/TUTORIAL.md +++ b/TUTORIAL.md @@ -2,16 +2,21 @@ ## Installation -For now, you'll have to install Grader manually. -The easiest way to do this is to clone the [grader repository](https://github.com/redkyn/grader.git). -Inside the cloned repository, run `pip3 install --user -e grader/`. -This will install a `grader` executable to `~/.local/bin` and make the install "editable" -- this way, changes made in the Grader repository apply anywhere you run Grader. +### The easy way -In the future, we plan to package Grader to make the install easier, but it's not yet ready for a `v0.1.0` release yet. +Use `pip`: `pip3 install redkyn-grader` You'll also need to have docker installed and be in the `docker` group so you can do dockery things. Plan to have a lot of free hard drive space -- docker is not exactly frugal with its bytes. +If you use `zsh`, you may want to source the [`zsh` completion script](misc/completions/_grader.zsh) too. + +### If you want to hack on Grader + +The easiest way to do this is to clone the [grader repository](https://github.com/redkyn/grader.git). +Inside the cloned repository, run `pip3 install --user -e redkyn-grader/`. +This will install a `grader` executable to `~/.local/bin` and make the install "editable" -- this way, changes made in the Grader repository apply anywhere you run Grader. + ## Setting up a new class The first thing you should do when setting Grader up for a course is to create a directory to hold student submissions, gradesheets, and the like.