Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #261

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create CONTRIBUTING.md #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Prerequisites

- node.js (from https://nodejs.org/en/ or the package manager of your choice)
- for CI node.js 12 is used, but node.js 16 and 17 should work as well
- node npm and npx are on the path (check that you can run `node -v`, `npm -v` and `npx -v`)

# Build locally

- `npm install` to download the dependencies
- `npm run start` to download the binaries to the binaries folder (only needed once)
- `npx electron-builder` to build the electron app to the dist/ folder
- `npx electron-builder -m` for macos
- `npx electron-builder -w` for windows
- `npx electron-builder -l` for linux app image