Skip to content

Commit f570674

Browse files
authored
Include dev-oriented build instructions in README.md
1 parent 1295aa0 commit f570674

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,16 @@ Create annotations for builds done in directory `/workspace/build/`
4242
run: |
4343
...
4444
```
45+
46+
## Dev Internals
47+
48+
### Directories
49+
50+
`src/` contains the sources; `dist/` is what people use in production.
51+
To compile `src/` into `dist/` run `npm run build`.
52+
53+
### Prerequisite packages for `npm run build`
54+
55+
Install **`nvm`** through `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash` or similar, as decribed e.g. [here](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04#option-3-installing-node-using-the-node-version-manager).
56+
Install **`npm`** by taking a recent version from the output of `nvm list-remote` and installing it through `nvm install v20` or similar.
57+
`npm run build` needs `ncc` which one needs to install through `npm i -g @vercel/ncc`.

0 commit comments

Comments
 (0)