From 3ab2851a4e5f7dd3e6335a466e8478982115eae8 Mon Sep 17 00:00:00 2001 From: Mike Matera Date: Fri, 27 Dec 2019 14:19:13 -0800 Subject: [PATCH] Update README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 41bb532..dda5133 100644 --- a/README.md +++ b/README.md @@ -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