Skip to content

Commit 2661c63

Browse files
committed
Update README.md
1 parent bcb7bfb commit 2661c63

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,22 @@ A demo instance of JupyterLite including the webR kernel and a sample Jupyter no
88

99
## Install
1010

11-
This package is not yet available on PyPI. You can install it from GitHub:
11+
This package is available via PyPI:
1212

1313
```bash
14-
pip install git+https://github.com/r-wasm/jupyterlite-webr-kernel.git
14+
pip install jupyterlite-webr
1515
```
1616

17-
or from a local clone:
17+
Once installed, build your JupyterLite site:
1818

1919
```bash
20-
git clone https://github.com/r-wasm/jupyterlite-webr-kernel
21-
cd jupyterlite-webr-kernel
22-
pip install .
20+
jupyter lite build
2321
```
2422

25-
Then build your JupyterLite site:
23+
The `_output` directory will contain the static JupyterLite site. You can serve it locally with the command,
2624

2725
```bash
28-
jupyter lite build
26+
jupyter lite serve
2927
```
3028

3129
## Configuration
@@ -65,7 +63,21 @@ While webR supports interrupting long running computations, interrupting cell ex
6563

6664
## Contributing
6765

68-
### Development install
66+
### Development installation
67+
68+
First, install a development version of the package from GitHub:
69+
70+
```bash
71+
pip install git+https://github.com/r-wasm/jupyterlite-webr-kernel.git
72+
```
73+
74+
or from a local clone:
75+
76+
```bash
77+
git clone https://github.com/r-wasm/jupyterlite-webr-kernel
78+
cd jupyterlite-webr-kernel
79+
pip install .
80+
```
6981

7082
Note: You will need NodeJS and Python 3.9+ to build the extension package. There is an environment.yml file for conda/mamba/micromamba users to create a conda environment with the required dependencies.
7183

0 commit comments

Comments
 (0)