Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dsavransky committed Jul 7, 2020
1 parent 4837011 commit deded54
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,26 @@ Please note: the Canvas routines have the potential to bork your gradebook and (

cornellGrading Installation
==============================
In the cloned grading directory:
To install from PyPI:

```
pip install cornellGrading
```

Or, with optional dependencies required to push LaTeX into Canvas HTML:

```
pip install cornellGrading[latex2html]
```

---
**NOTE**

The `latex2html` option requires the pandoc executable to be installed and in the system PATH. For detailed pandoc installation instructions see here: https://pandoc.org/installing.html

---

If cloning from github, in the cloned grading directory:

```
pip install --user .
Expand All @@ -26,8 +45,6 @@ In order to also install requirements needed push LaTeX into Canvas HTML, do:
pip install --user -e .[latex2html]
```

The `latex2html` option requires the pandoc executable to be installed and in the system PATH. For detailed pandoc installation instructions see here: https://pandoc.org/installing.html

cornellGrading Documentation
================================
Documentation is available here: https://grading.readthedocs.io/
Expand Down

0 comments on commit deded54

Please sign in to comment.