Skip to content

Commit 7ffb136

Browse files
committed
README: Update instructions to use pnpm
Signed-off-by: Rune Morling <ermo@serpentos.com>
1 parent 45435cf commit 7ffb136

1 file changed

Lines changed: 20 additions & 13 deletions

File tree

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
1-
TODO: Create main landing site + blog (potentially Astro) for "welcoming site" / project at AerynOS.com
1+
## NodeJS install prerequisites
22

3-
## How to install
3+
Before attempting to compile and show the website locally, please ensure that:
44

5-
npm install astro@5.3.1
6-
pushd node_modules/starlight-blog
7-
patch -i ../../patches/starlight-blog.patch -p1
8-
popd
5+
- NodeJS is installed on your system
6+
- `pnpm` is available and in your path
7+
- with NodeJS installed, you can run the following from your ${HOME} directory:
8+
```
9+
npm install pnpm@latest-10
10+
```
11+
- Make sure you add `${HOME}/node_modules/.bin` to your shell ${PATH}
12+
- With the above prerequisites satisfied, clone the present repo and cd into the root of it.
13+
- Then run:
14+
```
15+
pnpm install
16+
```
917
10-
Example patch output:
18+
## How to build and show the site locally in your browser
1119
12-
$ patch -i ../../patches/starlight-blog.patch -p1
13-
patching file components/Preview.astro
14-
patching file libs/content.ts
15-
patching file package.json
20+
After the above import and install operations have completed successfully on your system, run:
1621
17-
## How to build
22+
pnpm run dev
1823
19-
npm run dev
24+
... and follow the instructions shown.
25+
26+
At this point, any time you edit a page, the changes should show up live in your browser.

0 commit comments

Comments
 (0)