2
0
mirror of https://github.com/frappe/books.git synced 2024-09-19 19:19:02 +00:00

chore: add build instructions

This commit is contained in:
18alantom 2022-08-30 13:31:30 +05:30
parent 5cd940be8e
commit 3020a4e59d

View File

@ -79,11 +79,34 @@ cd books
# install dependencies
yarn
```
#### Development
To run Frappe Books in development mode (with hot reload, etc):
```bash
# start the electron app
yarn electron:serve
```
#### Build
To build Frappe Books and create an installer:
```bash
# start the electron app
yarn electron:build
```
**Note**
By default the above command will build for your computer's operating system and
architecture. To build for other environments (example: for linux from a windows
computer) check the _Building_ section at
[electron.build/cli](https://www.electron.build/cli).
So to build for linux you could use the `--linux` flag like so: `yarn electron:build --linux`.
## Contributions and Community
There are many ways you can contribute even if you don't code: