mirror of
https://github.com/frappe/books.git
synced 2024-12-23 03:19:01 +00:00
chore: add build instructions
This commit is contained in:
parent
5cd940be8e
commit
3020a4e59d
23
README.md
23
README.md
@ -79,11 +79,34 @@ cd books
|
|||||||
|
|
||||||
# install dependencies
|
# install dependencies
|
||||||
yarn
|
yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Development
|
||||||
|
|
||||||
|
To run Frappe Books in development mode (with hot reload, etc):
|
||||||
|
|
||||||
|
```bash
|
||||||
# start the electron app
|
# start the electron app
|
||||||
yarn electron:serve
|
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
|
## Contributions and Community
|
||||||
|
|
||||||
There are many ways you can contribute even if you don't code:
|
There are many ways you can contribute even if you don't code:
|
||||||
|
Loading…
Reference in New Issue
Block a user