Skip to content

Commit daa3012

Browse files
committed
Update readme
1 parent 3aaf77e commit daa3012

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
1-
# typescript-notebook README
1+
# TypeScript for Jupyter Notebooks
22

3+
A [Visual Studio Code](https://code.visualstudio.com/) extension required to get started with TypeScript in Jupyter notebooks.
4+
This extension will automatically install the necessary dependencies required to use TypeScript with [Jupyter Extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter).
5+
6+
### Quick Start
7+
8+
- **Step 1.** Install the [TypeScript Notebook Extension](https://marketplace.visualstudio.com/items?itemName=donjayamanne.typescript-notebook)
9+
- **Step 2.** Open or create a notebook file and start coding!
10+
- **Step 3.** Select the `TypeScript` kernel from the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) `Notebook: Select Kernel`
11+
12+
![QuickStart](https://raw.githubusercontent.com/DonJayamanne/typescript-notebook/master/resources/quickstart.gif)
313

4-
## Release Notes
514

6-
Users appreciate release notes as you update your extension.
15+
## Prerequisite
16+
* [Jupyter extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
17+
* [npm](https://www.npmjs.com/get-npm)
18+
19+
## TypeScript Kernel
20+
* [tslab](https://github.com/yunabe/tslab) is used as the kernel for Jupyter Notebooks.
21+
* Installing the `tslab` kernel for Jupyter Notebooks requires one to have Python & Jupyter installed.
22+
* However the [Jupyter extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) does not require either one of these (in a majority of the case).
23+
* This extension gets around the requirement of having to install Python & Jupyter.
24+
25+
## Release Notes
726

827
### 1.0.0
928

0 commit comments

Comments
 (0)