diff options
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0041cc849..96c37d302 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -13,7 +13,7 @@ | |||
13 | - [How can I contribute?](#how-can-i-contribute) | 13 | - [How can I contribute?](#how-can-i-contribute) |
14 | - [Setting up your development machine](#setting-up-your-development-machine) | 14 | - [Setting up your development machine](#setting-up-your-development-machine) |
15 | - [Install system-level dependencies](#install-system-level-dependencies) | 15 | - [Install system-level dependencies](#install-system-level-dependencies) |
16 | - [Node.js, pnpm](#nodejs-pnpm) | 16 | - [Node.js, npm, pnpm](#nodejs-npm-pnpm) |
17 | - [Git](#git) | 17 | - [Git](#git) |
18 | - [On Debian/Ubuntu](#on-debianubuntu) | 18 | - [On Debian/Ubuntu](#on-debianubuntu) |
19 | - [On Fedora](#on-fedora) | 19 | - [On Fedora](#on-fedora) |
@@ -52,7 +52,7 @@ If so, engage in the already existing discussion. | |||
52 | 52 | ||
53 | _Note:_ This list can likely get outdated. If so, please refer to the specific version of the [electronuserland builder](https://hub.docker.com/r/electronuserland/builder) that we use in our [Dockerfile](./Dockerfile). | 53 | _Note:_ This list can likely get outdated. If so, please refer to the specific version of the [electronuserland builder](https://hub.docker.com/r/electronuserland/builder) that we use in our [Dockerfile](./Dockerfile). |
54 | 54 | ||
55 | #### Node.js, pnpm | 55 | #### Node.js, npm, pnpm |
56 | 56 | ||
57 | Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [`package.json`](./package.json#engines) and [`recipes/package.json`](./recipes/package.json#engine) files. | 57 | Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [`package.json`](./package.json#engines) and [`recipes/package.json`](./recipes/package.json#engine) files. |
58 | 58 | ||
@@ -63,11 +63,12 @@ Currently, these are the combinations of system dependencies that work for MacOS | |||
63 | $ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json | 63 | $ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json |
64 | { | 64 | { |
65 | "node": "16.18.0", | 65 | "node": "16.18.0", |
66 | "npm": "8.19.2", | ||
66 | "pnpm": "7.14.0" | 67 | "pnpm": "7.14.0" |
67 | } | 68 | } |
68 | ``` | 69 | ``` |
69 | 70 | ||
70 | _Note:_ You can choose any version manager to manage multiple versions of `node` and `pnpm`. For eg, [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://github.com/asdf-vm/asdf). | 71 | _Note:_ You can choose any version manager to manage multiple versions of `node` and `npm`. For eg, [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://github.com/asdf-vm/asdf). |
71 | 72 | ||
72 | #### Git | 73 | #### Git |
73 | 74 | ||
@@ -89,7 +90,7 @@ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel rpm | |||
89 | 90 | ||
90 | Please make sure you have the following installed: | 91 | Please make sure you have the following installed: |
91 | 92 | ||
92 | - Microsoft Visual Studio Build Tools (2017, 2019 or 2022 - with Windows 10 SDK selected). | 93 | - Microsoft Visual Studio Build Tools (2019 or higher - with Windows 10 SDK selected). |
93 | 94 | ||
94 | ### Clone repository with submodule | 95 | ### Clone repository with submodule |
95 | 96 | ||
@@ -146,7 +147,7 @@ mv /ferdium/latest-linux.yml /ferdium-out/latest-linux-$GIT_SHA.yml | |||
146 | Run this command on the terminal: | 147 | Run this command on the terminal: |
147 | 148 | ||
148 | ```bash | 149 | ```bash |
149 | pnpm debug | 150 | npm run debug |
150 | ``` | 151 | ``` |
151 | 152 | ||
152 | Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`. | 153 | Note: please prefer [`debug()`](https://github.com/visionmedia/debug) over `console.log()`. |