From eb4ffba68a24ce2e3eb3a1a816bd7254f23faa34 Mon Sep 17 00:00:00 2001 From: begin-theadventure <99835765+begin-theadventure@users.noreply.github.com> Date: Wed, 29 Mar 2023 14:47:36 +0200 Subject: docs: Expand on the Setup (build) instructions (#240) * Expand on the Setup (build) instructions. * Expand on the Setup instructions: corrections. * Expand on the Setup instructions: add json. * . Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * Add cd .. * Update docs/DEVELOPMENT.md Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * Update docs/DEVELOPMENT.md Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> * Formatting --------- Co-authored-by: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> --- docs/DEVELOPMENT.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 02832722..370bf42b 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -14,7 +14,6 @@ As for splitting logic between _frontend_ and _backend_, state and UI related lo Make sure you have the necessary dependencies for Tauri installed as described in this link: https://tauri.app/v1/guides/getting-started/prerequisites - Then, install `npm` dependencies with ```sh @@ -24,7 +23,7 @@ npm install Install UI dependencies too ```sh -cd src-vue && npm install +cd src-vue && npm install && cd .. ``` Then for developing @@ -35,6 +34,30 @@ npx tauri dev Automatic recompiling on save is enabled for both the Rust and the Typescript/Vue code. +If you want to build FlightCore from source, run + +```sh +npx tauri build +``` + +This will build the executable and bundles, such as `AppImage`, `.deb` or `.msi`. + +To build just the executable, edit [tauri.conf.json](https://github.com/R2NorthstarTools/FlightCore/blob/main/src-tauri/tauri.conf.json) in the same folder: + +```json + "bundle": { + "active": true, +``` + +Change `active` from `true` to `false`, and bundles won't be included afterwards. + +To disable the updater (which requires a private key) change `active` value to `false`: + +```json + "updater": { + "active": true, +``` + ## Tauri An introduction to Tauri can be seen in this short YouTube video: https://youtu.be/-X8evddpu7M -- cgit v1.2.3