From 3020a4e59d00c672f9182328625ccbe8f6faaa33 Mon Sep 17 00:00:00 2001 From: 18alantom <2.alan.tom@gmail.com> Date: Tue, 30 Aug 2022 13:31:30 +0530 Subject: [PATCH] chore: add build instructions --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index c30224bd..7109166a 100644 --- a/README.md +++ b/README.md @@ -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: