MindWorkAI/AI-Studio
MindWorkAI/AI-Studio
1
0
Fork 0
mirror of https://github.com/MindWorkAI/AI-Studio.git synced 2025-04-28 21:59:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Syntax & spelling

Browse Source
This commit is contained in:
Thorsten Sommer 2024-09-03 17:23:36 +02:00
parent 1472475f7e
commit 80854c9811
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/Build.md
View File

@ -4,18 +4,18 @@ You just want to use the app? Then simply [download the appropriate setup for yo
## Prerequisites ## Prerequisites
1. Install the [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). 1. Install the [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
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. [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. 3. [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.
4. Clone the repository. 4. Clone the repository.
## Build instructions ## Build instructions
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.
2. Navigate to the `/app/MindWork AI Studio` directory within the repository. 3. Navigate to the `/app/MindWork AI Studio` directory within the repository.
3. To build the current version, run `nu build.nu publish`. 4. To build the current version, run `nu build.nu publish`.
- 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 setup program will be located in `runtime/target/release/bundle` afterward.
4. 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`.
3. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes. 3. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes.