@@ -0,0 +1,37 @@
1+# TutorialD Jupyter Kernel for Project:M36
2+
3+## Introduction
4+
5+[The Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html) is web-based tool for experimenting with various languages. Project:M36 offers a Jupyter kernel for the TutorialD interpreter.
6+
7+## Installation
8+
9+To install the `tutd` kernel:
10+
11+* install the `itutd` module into your jupyter virtual environment:
12+```
13+$ cd project-m36/jupyter/itutd
14+$ python setup.py install
15+```
16+
17+* install `kernel.json`:
18+
19+ ```$ mkdir ~/Library/Jupyter/kernels/itutd && cp project-m36/jupyter/kernel.json ~/Library/Jupyter/kernels/itutd``` (macOS)
20+
21+ ```$ mkdir ~/.local/share/jupyter/kernels/tutd && cp project-m36/jupyter/kernel.json ~/.local/share/jupyter/kernels/tutd``` (Linux)
22+
23+ ```$ mkdir %APPDATA%\jupyter\kernels\tutd && copy project-m36\jupyter\kernel.json %APPDATA%\jupyter\kernels\tutd``` (Windows)
24+
25+* check that the kernel is detected:
26+```
27+$ jupyter kernelspec list
28+Available kernels:
29+ python2 ...
30+ tutd ...
31+```
32+
33+## Usage
34+
35+With the kernel installed, run `jupyter notebook` for the web-based interface and click "New" at the top right of the page. The TutorialD kernel should be in the list.
36+
37+Once a new TutorialD notebook is opened, the interpreter is identical to the `tutd` command line interpreter and accepts the same commands. If you are new to Project:M36-flavored TutorialD, please [read the tutorial](/docs/tutd_tutorial.markdown).