Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-matera committed Dec 27, 2019
1 parent d4852d3 commit 3ab2851
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ pip install --upgrade pip
pip install -r requirements.txt
```

## Building the Notebooks

The notebooks are generated by the tool in `tools/gen_questions.py`. The notebooks are generated from Python source that contains markdown for a question and the correct answer. The answer is used to generate a preview inside the notebook that shows what the correct answer should look like. The preview is an important prompt to help students know they have the right answer.

The notebooks are not checked into Git. They are generated using the `makefile` in the root of this project:

```sh
make
```

## Viewing the Notebooks

Run Jupyter:

```sh
Expand Down

0 comments on commit 3ab2851

Please sign in to comment.