From 1b1989e8ebff44e4550a97e5665d7f013321275a Mon Sep 17 00:00:00 2001 From: Thorsten Sommer Date: Mon, 14 Oct 2024 19:23:40 +0200 Subject: [PATCH] Improved build introductions (#165) --- documentation/Build.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/documentation/Build.md b/documentation/Build.md index 1f1c10e..795c65b 100644 --- a/documentation/Build.md +++ b/documentation/Build.md @@ -6,17 +6,27 @@ You just want to use the app? Then simply [download the appropriate setup for yo 2. [Install the Rust compiler](https://www.rust-lang.org/tools/install) in the latest version. 3. Met the prerequisites for building [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/). Node.js is **not** required, though. 4. Install the Tauri CLI by running `cargo install --version 1.6.2 tauri-cli`. -5. [Install NuShell](https://www.nushell.sh/) when you want to prepare a release or build a local binary. NuShell works on all operating systems and is required because the build script is written in NuShell. +5. [Install NuShell](https://www.nushell.sh/). NuShell works on all operating systems and is required because the build script is written in NuShell. 6. Clone the repository. -## Build instructions +## One-time mandatory steps +Regardless of whether you want to build the app locally for yourself (not trusting the pre-built binaries) or test your changes before creating a PR, you have to run the following commands at least once: + +1. Open a terminal using NuShell. +2. Navigate to the `/app/MindWork AI Studio` directory within the repository. +3. Run `dotnet restore` to bring up the .NET dependencies. +4. Run `nu build.nu publish` to build the entire app. + +This is necessary because the build script and the Tauri framework assume that the .NET app is available as a so-called "sidecar." Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development as well. + +## Build AI Studio from source In order to build MindWork AI Studio from source instead of using the pre-built binaries, follow these steps: 1. Ensure you have met all the prerequisites. 2. Open a terminal with NuShell. 3. Navigate to the `/app/MindWork AI Studio` directory within the repository. -4. To build the current version, run `nu build.nu publish`. +4. To build the current version, run `nu build.nu publish` to build the entire app. - This will build the app for the current operating system, for both x64 (Intel, AMD) and ARM64 (e.g., Apple Silicon, Raspberry Pi). - - The setup program will be located in `runtime/target/release/bundle` afterward. + - The final setup program will be located in `runtime/target/release/bundle` afterward. 5. In order to create a new release: 1. Before finishing the PR, make sure to create a changelog file in the `/app/MindWork AI Studio/wwwroot/changelog` directory. The file should be named `vX.Y.Z.md` and contain the changes made in the release (your changes and any other changes that are part of the release). 2. To prepare a new release, run `nu build.nu prepare `, where `` is either `patch`, `minor`, or `major`.