aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar André Oliveira <37463445+SpecialAro@users.noreply.github.com>2022-04-20 22:05:32 +0100
committerLibravatar GitHub <noreply@github.com>2022-04-20 21:05:32 +0000
commita8caecce9b8d665e3fe2910060b833e2255578b2 (patch)
tree64d3c37039ab619fe0638edafcef88061be95d5a /CONTRIBUTING.md
parentUpgrade 'node' to '18.0.0' and 'node-gyp' to '9.0.0' (#19) (diff)
downloadferdium-app-a8caecce9b8d665e3fe2910060b833e2255578b2.tar.gz
ferdium-app-a8caecce9b8d665e3fe2910060b833e2255578b2.tar.zst
ferdium-app-a8caecce9b8d665e3fe2910060b833e2255578b2.zip
Upgrade node and node-gyp to build on Windows 11 (#18)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e3cf72f42..abcbac9f2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -91,12 +91,10 @@ dnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel rpm
91 91
92#### Windows 92#### Windows
93 93
94Please make sure you run this command as an administrator: 94Please make sure you have the following installed:
95
96```bash
97npm i -g windows-build-tools --vs2015
98```
99 95
96- Python 3 or higher (we recommend the latest version: [3.10.4](https://www.python.org/ftp/python/3.10.4/python-3.10.4-amd64.exe))
97- Microsoft Visual Studio Build Tools (2019 or higher) - Only tested with 2019 so far.
100### Clone repository with submodule 98### Clone repository with submodule
101 99
102```bash 100```bash
@@ -116,6 +114,14 @@ export ELECTRON_CACHE=$HOME/.cache/electron
116export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder 114export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
117``` 115```
118 116
117#### If you are using Powershell:
118If you are using Powershell make sure you set the following env vars
119```
120$env:CI = $true
121$env:ELECTRON_CACHE = $HOME + '\.cache\electron'
122$env:ELECTRON_BUILDER_CACHE = $HOME + '\.cache\electron-builder'
123```
124
119### Install dependencies 125### Install dependencies
120 126
121Run the following command to install all dependencies, and link sibling modules with Ferdium. 127Run the following command to install all dependencies, and link sibling modules with Ferdium.