Skip to content

Commit

Permalink
Create SETUP.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CrazyMarvin authored Nov 12, 2023
1 parent 0c5daa2 commit dca64fa
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Building the application.
Install Node.js 20 on your machine and go to the project root and run following command:
```
npm run install
```
In order to generate the executables run following command:
```
npm run package
```
To generate executables for all platforms run this:
```
npm run package-all
```

Note: Executables can be found in `release/build` folder.

## Customizing the application
- Localization is located on `src/renderer/i18n` folder.
- App configuration can be found on `src/renderer/config` folder

0 comments on commit dca64fa

Please sign in to comment.