MindWorkAI/AI-Studio
MindWorkAI/AI-Studio
1
0
Fork 0
mirror of https://github.com/MindWorkAI/AI-Studio.git synced 2025-02-05 12:49:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improved build introductions (#165)

Browse Source
This commit is contained in:
Thorsten Sommer 2024-10-14 19:23:40 +02:00 committed by GitHub
parent afa5df894e
commit 1b1989e8eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/Build.md
View File

@ -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. 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. 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`. 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. 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: 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. 1. Ensure you have met all the prerequisites.
2. Open a terminal with NuShell. 2. Open a terminal with NuShell.
3. Navigate to the `/app/MindWork AI Studio` directory within the repository. 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). - 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: 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). 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 <ACTION>`, where `<ACTION>` is either `patch`, `minor`, or `major`. 2. To prepare a new release, run `nu build.nu prepare <ACTION>`, where `<ACTION>` is either `patch`, `minor`, or `major`.