Update README.md

This commit is contained in:
Observer KRypt0n_ 2021-10-13 17:17:14 +02:00
parent 8aae9d7059
commit 93a03a328a
No known key found for this signature in database
GPG key ID: DC5D4EC1303465DA

View file

@ -34,21 +34,18 @@ In the `package.json` you should change these parameters:
Directory `src` stores your [TypeScript](https://typescriptlang.org) and [SASS](https://sass-lang.com) code. When you run `npm run dev` command in console - they will compile to the js and css files inside `public` directory
In the `public` stored information about your application - images it uses, html pages and something you want to use
In the `public` stored information about your application - images it uses, html pages and something you want to use. Other directories will not be available in the compiled binaries
Default application page is `public/html/index.html`
To run your application - use `npm start` command. It will automatically run `npm run dev`
To build application for any systems - `npm run build:all`
To build binaries run:
* For Windows only: `npm run build:win`
* For Linux only: `npm run build:linux`
* For MacOS only: `npm run build:darwin`
* For Windows: `npm run build:win`
* For Linux: `npm run build:linux`
All binaries will appear in the `dist` directory in a folder with name `[app name]-[platform]-[arch]`, for example `electron-blank-app-linux-x64`
To pack linux binary to the flatpak binary you can run `npm run pack:flatpak`. This operation requires pre-installed `flatpak` and `flatpak-build` packages
All binaries will appear in the `dist` directory
<br>