Skip to content

Commit 0dabed4

Browse files
committed
update readme to use pnpm instead of npm
1 parent 74211a8 commit 0dabed4

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

README.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@
77

88
## How it works
99

10-
- [main](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/main) branch contains the source code
11-
- [gh-pages](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/gh-pages) branch contains the generated website
1210
- the contents of each page are stored in [yaml](https://yaml.org/) format in [src/content](/src/content)
1311
- there is a corresponding [pug](https://pugjs.org/) HTML template for each page in [src/pug](/src/pug)
1412
- uses CSS and icons from the [Bootstrap](https://getbootstrap.com/) framework
15-
- uses [npm](https://www.npmjs.com/) and [webpack](https://webpack.js.org/) to manage the build and dependencies
13+
- uses [pnpm](https://pnpm.io/) and [webpack](https://webpack.js.org/) to manage the build and dependencies
1614

1715
## Structure
1816

@@ -27,7 +25,7 @@
2725
- [src/assets](/src/assets)
2826
- contains the image and video files
2927
- [src/scss](/src/scss)
30-
- import and customize [Bootstrap css](https://getbootstrap.com/docs/5.1/customize/sass/)
28+
- import and customize [Bootstrap css](https://getbootstrap.com/docs/5.3/customize/sass/)
3129
- [src/js](/src/js)
3230
- additional client-side javascript
3331
- [src/index.js](/src/index.js)
@@ -37,8 +35,7 @@
3735

3836
On every commit to the main branch:
3937

40-
- [deploy.yml](https://github.com/spatial-model-editor/spatial-model-editor.github.io/actions/workflows/deploy.yml) action builds website & deploys to [gh-pages](https://github.com/spatial-model-editor/spatial-model-editor.github.io/tree/gh-pages)
41-
- github pages hosts these files at [spatial-model-editor.github.io](https://spatial-model-editor.github.io/)
38+
- [deploy.yml](https://github.com/spatial-model-editor/spatial-model-editor.github.io/actions/workflows/deploy.yml) action builds website & deploys to github-pages at [spatial-model-editor.github.io](https://spatial-model-editor.github.io/)
4239

4340
## How to edit locally
4441

@@ -48,16 +45,13 @@ On every commit to the main branch:
4845
- (optional) install pre-commit to auto-format code
4946
- `pip install pre-commit`
5047
- `pre-commit install`
51-
- install node (ideally v20 to match versions used for deployment)
52-
- macOS: `brew install node`
53-
- windows: https://nodejs.org/en/
54-
- ubuntu: `sudo apt install nodejs npm`
55-
- linux/macOS tool to manage multiple node versions: https://github.com/nodenv/nodenv
56-
- (many) more options: https://nodejs.org/en/download/package-manager
57-
- install website node dependencies
58-
- `npm install`
48+
- install [pnpm](https://pnpm.io/installation)
49+
- windows: `iwr https://get.pnpm.io/install.ps1 -useb | iex`
50+
- linux/macOS: `curl -fsSL https://get.pnpm.io/install.sh | sh -`
51+
- install website dependencies
52+
- `pnpm install`
5953
- start a live in-browser local preview of the website
60-
- `npm start`
54+
- `pnpm start`
6155
- make changes to the files in `src/` and the preview will update automatically
6256

6357
## Adding a new page

0 commit comments

Comments
 (0)