Skip to content

Commit 47ae54b

Browse files
ian-r-roseian-r-rose
authored
Merge pull request #119 from gnestor/readme-jlpm
Use jlpm vs. yarn in READMEs
2 parents b58beaf + 9c0d015 commit 47ae54b

File tree

6 files changed

+112
-70
lines changed

6 files changed

+112
-70
lines changed

‎README.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,21 @@ This is a [monorepo](https://github.com/lerna/lerna#what-does-a-lerna-repo-look-
2424

2525
## Contributing
2626

27-
### Developer install
27+
## Requirements
2828

29-
Requires the [yarn](https://yarnpkg.com/) package manager.
29+
* Node.js >= 5 (see [Installing Node.js and jlpm](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md#installing-nodejs-and-jlpm) in the JupyterLab docs)
30+
31+
### Install
32+
33+
The `jlpm` command is JupyterLab's pinned version of
34+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
35+
`yarn` or `npm` in lieu of `jlpm` below.
3036

3137
```bash
3238
git clone https://github.com/jupyterlab/jupyter-renderers.git
3339
cd jupyter-renderers
34-
yarn install
35-
yarn run build
40+
jlpm
41+
jlpm build
3642
```
3743

3844
### Link extensions with JupyterLab
@@ -46,7 +52,7 @@ jupyter labextension link packages/geojson-extension
4652
Link all extensions in `packages`:
4753

4854
```bash
49-
yarn run link
55+
jlpm run link
5056
```
5157

5258
### Rebuilding extensions
@@ -55,17 +61,17 @@ After making changes to the source packages, the packages must be rebuilt:
5561

5662
```bash
5763
# Rebuild the source
58-
yarn run build
64+
jlpm build
5965

6066
# Rebuild the JupyterLab staging directory
6167
jupyter lab build
6268
```
6369

6470
You may also watch the `jupyter-renderers` directory for changes and automatically rebuild:
6571

66-
```
72+
```bash
6773
# In one terminal tab, watch the jupyter-renderers directory
68-
yarn run watch
74+
jlpm watch
6975

7076
# In another terminal tab, run jupyterlab with the watch flag
7177
jupyter lab --watch
@@ -74,7 +80,7 @@ jupyter lab --watch
7480
### Publishing packages
7581

7682
```bash
77-
yarn run publish
83+
jlpm publish
7884
# If publishing a package for the first time
7985
npm access public @jupyterlab/<extension name>
8086
```

‎packages/fasta-extension/README.md‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,16 @@ A JupyterLab extension for rendering
66

77
![demo](http://g.recordit.co/temizjae9X.gif)
88

9-
## Prerequisites
9+
## Requirements
1010

1111
* JupyterLab ^0.30.0
12+
* Node.js >= 5
13+
14+
## Install
15+
16+
```bash
17+
jupyter labextension install @jupyterlab/fasta-extension
18+
```
1219

1320
## Usage
1421

@@ -33,28 +40,28 @@ SATVSEINSETDFVAKNDQFIALTKDTTAHIQSNSLQSVEELHSSTINGVKFEEYLKSQI
3340
ATIGENLVVRRFATLKAGANGVVNGYIHTNGRVGVVIAAACDSAEVASKSRDLLRQICMH""")
3441
```
3542

36-
To render a `.fasta` file, simply open it:
43+
To render a `.fasta` file, simply open it.
3744

38-
## Install
45+
## Contributing
3946

40-
```bash
41-
jupyter labextension install @jupyterlab/fasta-extension
42-
```
47+
### Install
4348

44-
## Development
49+
The `jlpm` command is JupyterLab's pinned version of
50+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
51+
`yarn` or `npm` in lieu of `jlpm` below.
4552

4653
```bash
4754
# Clone the repo to your local environment
4855
git clone https://github.com/jupyterlab/jupyter-renderers.git
4956
cd jupyter-renderers
5057
# Install dependencies
51-
yarn install
58+
jlpm
5259
# Build Typescript source
53-
yarn run build
60+
jlpm build
5461
# Link your development version of the extension with JupyterLab
5562
jupyter labextension link packages/fasta-extension
5663
# Rebuild Typescript source after making changes
57-
yarn run build
64+
jlpm build
5865
# Rebuild JupyterLab after making any changes
5966
jupyter lab build
6067
```
@@ -64,11 +71,11 @@ You can watch the jupyter-renderers directory and run JupyterLab in watch mode t
6471
```bash
6572
# Run jupyterlab in watch mode in one terminal tab
6673
jupyter lab --watch
67-
# Watch the jupyter-renderers directory
68-
yarn run watch
74+
# Watch the jupyter-renderers directory in another terminal tab
75+
jlpm watch
6976
```
7077

71-
## Uninstall
78+
### Uninstall
7279

7380
```bash
7481
jupyter labextension uninstall @jupyterlab/fasta-extension

‎packages/geojson-extension/README.md‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,16 @@ A JupyterLab extension for rendering GeoJSON
44

55
![demo](http://g.recordit.co/SsWJCpKIJy.gif)
66

7-
## Prerequisites
7+
## Requirements
88

99
* JupyterLab ^0.30.0
10+
* Node.js >= 5
11+
12+
## Install
13+
14+
```bash
15+
jupyter labextension install @jupyterlab/geojson-extension
16+
```
1017

1118
## Usage
1219

@@ -63,28 +70,28 @@ GeoJSON(
6370
)
6471
```
6572

66-
To render a `.geojson` or `.geo.json` file, simply open it:
73+
To render a `.geojson` or `.geo.json` file, simply open it.
6774

68-
## Install
75+
## Contributing
6976

70-
```bash
71-
jupyter labextension install @jupyterlab/geojson-extension
72-
```
77+
### Install
7378

74-
## Development
79+
The `jlpm` command is JupyterLab's pinned version of
80+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
81+
`yarn` or `npm` in lieu of `jlpm` below.
7582

7683
```bash
7784
# Clone the repo to your local environment
7885
git clone https://github.com/jupyterlab/jupyter-renderers.git
7986
cd jupyter-renderers
8087
# Install dependencies
81-
yarn install
88+
jlpm
8289
# Build Typescript source
83-
yarn run build
90+
jlpm build
8491
# Link your development version of the extension with JupyterLab
8592
jupyter labextension link packages/geojson-extension
8693
# Rebuild Typescript source after making changes
87-
yarn run build
94+
jlpm build
8895
# Rebuild JupyterLab after making any changes
8996
jupyter lab build
9097
```
@@ -94,11 +101,11 @@ You can watch the jupyter-renderers directory and run JupyterLab in watch mode t
94101
```bash
95102
# Run jupyterlab in watch mode in one terminal tab
96103
jupyter lab --watch
97-
# Watch the jupyter-renderers directory
98-
yarn run watch
104+
# Watch the jupyter-renderers directory in another terminal tab
105+
jlpm watch
99106
```
100107

101-
## Uninstall
108+
### Uninstall
102109

103110
```bash
104111
jupyter labextension uninstall @jupyterlab/geojson-extension

‎packages/katex-extension/README.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sufficient for your purposes, this may be the extension for you!
1212
If you equations are not rendering properly with this extension,
1313
you probably will want to fall back to MathJax.
1414

15-
## Prerequisites
15+
## Requirements
1616

1717
* JupyterLab ^0.28.0
1818
* Node.js >= 5
@@ -23,20 +23,26 @@ you probably will want to fall back to MathJax.
2323
jupyter labextension install @jupyterlab/katex-extension
2424
```
2525

26-
## Development
26+
## Contributing
27+
28+
### Install
29+
30+
The `jlpm` command is JupyterLab's pinned version of
31+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
32+
`yarn` or `npm` in lieu of `jlpm` below.
2733

2834
```bash
2935
# Clone the repo to your local environment
3036
git clone https://github.com/jupyterlab/jupyter-renderers.git
3137
cd jupyter-renderers
3238
# Install dependencies
33-
yarn install
39+
jlpm
3440
# Build Typescript source
35-
yarn run build
41+
jlpm build
3642
# Link your development version of the extension with JupyterLab
3743
jupyter labextension link packages/katex-extension
3844
# Rebuild Typescript source after making changes
39-
yarn run build
45+
jlpm build
4046
# Rebuild JupyterLab after making any changes
4147
jupyter lab build
4248
```
@@ -46,11 +52,11 @@ You can watch the jupyter-renderers directory and run JupyterLab in watch mode t
4652
```bash
4753
# Run jupyterlab in watch mode in one terminal tab
4854
jupyter lab --watch
49-
# Watch the jupyter-renderers directory
50-
yarn run watch
55+
# Watch the jupyter-renderers directory in another terminal tab
56+
jlpm watch
5157
```
5258

53-
## Uninstall
59+
### Uninstall
5460

5561
```bash
5662
jupyter labextension uninstall @jupyterlab/katex-extension

‎packages/plotly-extension/README.md‎

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,17 @@ A JupyterLab extension for rendering Plotly charts
44

55
![demo](http://g.recordit.co/Hq3qZhqkFG.gif)
66

7-
## Prerequisites
7+
## Requirements
88

99
* JupyterLab ^0.30.0
10-
* plotly.py >= 2.0.0
10+
* Node.js >= 5
11+
* plotly.py >= 2.0.0 (optional)
12+
13+
## Install
14+
15+
```bash
16+
jupyter labextension install @jupyterlab/plotly-extension
17+
```
1118

1219
## Usage
1320

@@ -46,32 +53,34 @@ from plotly.offline import iplot
4653
trace = plotly.graph_objs.Heatmap(z=[[1, 20, 30],
4754
[20, 1, 60],
4855
[30, 60, 1]])
56+
4957
fig = dict(data=[trace])
58+
5059
iplot(fig)
5160
```
5261

53-
To render a `.plotly` or `.plotly.json` file, simply open it:
62+
To render a `.plotly` or `.plotly.json` file, simply open it.
5463

55-
## Install
64+
## Contributing
5665

57-
```bash
58-
jupyter labextension install @jupyterlab/plotly-extension
59-
```
66+
### Install
6067

61-
## Development
68+
The `jlpm` command is JupyterLab's pinned version of
69+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
70+
`yarn` or `npm` in lieu of `jlpm` below.
6271

6372
```bash
6473
# Clone the repo to your local environment
6574
git clone https://github.com/jupyterlab/jupyter-renderers.git
6675
cd jupyter-renderers
6776
# Install dependencies
68-
yarn install
77+
jlpm
6978
# Build Typescript source
70-
yarn run build
79+
jlpm build
7180
# Link your development version of the extension with JupyterLab
7281
jupyter labextension link packages/plotly-extension
7382
# Rebuild Typescript source after making changes
74-
yarn run build
83+
jlpm build
7584
# Rebuild JupyterLab after making any changes
7685
jupyter lab build
7786
```
@@ -81,11 +90,11 @@ You can watch the jupyter-renderers directory and run JupyterLab in watch mode t
8190
```bash
8291
# Run jupyterlab in watch mode in one terminal tab
8392
jupyter lab --watch
84-
# Watch the jupyter-renderers directory
85-
yarn run watch
93+
# Watch the jupyter-renderers directory in another terminal tab
94+
jlpm watch
8695
```
8796

88-
## Uninstall
97+
### Uninstall
8998

9099
```bash
91100
jupyter labextension uninstall @jupyterlab/plotly-extension

0 commit comments

Comments
 (0)