From 7f43b9ab9dd088e0e32a27b5c71e5ec45676bdc1 Mon Sep 17 00:00:00 2001 From: Thorsten Sommer Date: Mon, 14 Apr 2025 19:03:50 +0200 Subject: [PATCH] Updated the build instructions --- documentation/Build.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/documentation/Build.md b/documentation/Build.md index b25a27ef..a723c6a0 100644 --- a/documentation/Build.md +++ b/documentation/Build.md @@ -6,30 +6,28 @@ 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/). NuShell works on all operating systems and is required because the build script is written in NuShell. -6. Clone the repository. +5. Clone the repository. ## 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. +1. Open a terminal. +2. Navigate to the `/app/Build` directory within the repository. +3. Run `dotnet run build` 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` to build the entire app. +2. Open a terminal. +3. Navigate to the `/app/Build` directory within the repository. +4. To build the current version, run `dotnet run build` 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 final setup program will be located in `runtime/target/release/bundle` afterward. + - The final setup program will be located in `runtime/target/release` 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`. + 2. To prepare a new release, run `dotnet run release --action `, where `` is either `patch`, `minor`, or `major`. 3. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes. 4. Your proposed changes will be reviewed and merged. 5. Once the PR is merged, a member of the maintainers team will create & push an appropriate git tag in the format `vX.Y.Z`. @@ -39,8 +37,8 @@ In order to build MindWork AI Studio from source instead of using the pre-built ## Run the app locally with all your changes Do you want to test your changes before creating a PR? Follow these steps: 1. Ensure you have met all the prerequisites. -2. At least once, you have to run the `nu build.nu publish` command (see above, "Build instructions"). This is necessary because the Tauri framework checks whether the .NET app as so-called "sidecar" is available. Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development. -3. Open a terminal (in this case, it doesn't have to be NuShell). +2. At least once, you have to run the `dotnet run build` command (see above, "Build instructions"). This is necessary because the Tauri framework checks whether the .NET app as so-called "sidecar" is available. Although the sidecar is only necessary for the final release and shipping, Tauri requires it to be present during development. +3. Open a terminal. 4. Navigate to the `runtime` directory within the repository, e.g. `cd repos/mindwork-ai-studio/runtime`. 5. Run `cargo tauri dev --no-watch`.