Skip to content

Commit df31f56

Browse files
committed
add nodejs, python, ipykernel instruction; remove gallery
1 parent 2eda968 commit df31f56

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,43 @@ overwhelmed by the great number of code snippets as the projects grow.
1414

1515
![screenshot](./screenshot-canvas.png)
1616

17-
# Gallery
17+
<!-- # Gallery
1818
1919
Thanks to our community, we now have CodePod showcases ranging from analytical geometry to bioinformatics.
2020
2121
- [plotting common functions](https://app.codepod.io/repo/2ncnioylo9abo3otdxjs)
2222
- [image operations using skimage](https://user-images.githubusercontent.com/44469195/239033643-decbd7ae-29bb-44b9-af33-d4cb7c2bce46.png)
23-
- [tel-siRNA sequence detector](https://app.codepod.io/repo/b94n7n00a9395xwhv1o8)
23+
- [tel-siRNA sequence detector](https://app.codepod.io/repo/b94n7n00a9395xwhv1o8) -->
2424

2525
# Install
2626

27-
You can install codepod CLI app with npm::
27+
Step 1: install prerequisite: [nodejs](https://nodejs.org/en/download) runtime
28+
and python & ipykernel:
29+
30+
```
31+
brew install node # example for MacOS
32+
pip3 install ipykernel
33+
```
34+
35+
Step 2: Install codepod CLI app from [npm registry](https://www.npmjs.com/package/codepod):
2836

2937
```
3038
> npm install -g codepod
3139
> codepod --version
3240
# 0.0.7
3341
```
3442

35-
You can use it like this:
43+
Step 3: launch CodePod from terminal:
3644

3745
```
38-
> codepod /path/to/repo
46+
> codepod /path/to/local/repo
3947
# ... 🚀 Server ready at http://localhost:4001
4048
```
4149

42-
Open this URL in your browser to see the app. The files will be saved to the directory `/path/to/repo/.codepod/yjs.[bin|json]`.
50+
Open this URL in your browser to see the app. The files will be saved to the
51+
directory `/path/to/repo/.codepod/yjs.[bin|json]`.
4352

44-
Update the app:
53+
In the future, you can update the app:
4554

4655
```
4756
> npm update -g codepod

0 commit comments

Comments
 (0)