From a66ef9a9b2290c68051b2eb283556af95ae96933 Mon Sep 17 00:00:00 2001 From: Thorsten Sommer Date: Sun, 23 Jun 2024 19:20:29 +0200 Subject: [PATCH] Refactored the build instruction into its own file --- README.md | 14 +------------- documentation/Build.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 13 deletions(-) create mode 100644 documentation/Build.md diff --git a/README.md b/README.md index 6ebaaa4e..54fe0f61 100644 --- a/README.md +++ b/README.md @@ -37,19 +37,7 @@ Here's an exciting look at some of the features we're planning to add to MindWor Stay tuned for more updates and enhancements to make MindWork AI Studio even more powerful and versatile 🤩. ## Building -You just want to use the app? Then simply [download the appropriate setup for your operating system](documentation/Setup.md). This chapter is intended for developers who want to modify and customize the code. - -In order to build MindWork AI Studio from source instead of using the pre-built binaries, follow these steps: -1. Install the .NET 8 SDK. -2. Install the Rust compiler. -3. Install NuShell. This shell works on all operating systems and is required because the build script is written in NuShell. -4. Clone the repository. -5. Open a terminal with NuShell. -6. Navigate to the `/app/MindWork AI Studio` directory within the repository. -7. 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). - - The setup program will be located in `runtime/target/release/bundle` afterward. -8. To prepare a new release, run `nu build.nu prepare `, where `` is either `patch`, `minor`, or `major`. +You want to know how to build MindWork AI Studio from source? [Check out the instructions here](documentation/Build.md). ## License MindWork AI Studio is licensed under the `FSL-1.1-MIT` license (functional source license). Here’s a simple rundown of what that means for you: diff --git a/documentation/Build.md b/documentation/Build.md new file mode 100644 index 00000000..bf72247f --- /dev/null +++ b/documentation/Build.md @@ -0,0 +1,20 @@ +# Building +You just want to use the app? Then simply [download the appropriate setup for your operating system](Setup.md). This chapter is intended for developers who want to modify and customize the code. + +In order to build MindWork AI Studio from source instead of using the pre-built binaries, follow these steps: +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. +3. [Install NuShell](https://www.nushell.sh/). This shell works on all operating systems and is required because the build script is written in NuShell. +4. Clone the repository. +5. Open a terminal with NuShell. +6. Navigate to the `/app/MindWork AI Studio` directory within the repository. +7. 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). + - The setup program will be located in `runtime/target/release/bundle` afterward. +8. In order to create a new release: + 1. To prepare a new release, run `nu build.nu prepare `, where `` is either `patch`, `minor`, or `major`. + 2. The actual release will be built by our GitHub Workflow. For this to work, you need to create a PR with your changes. + 3. Your proposed changes will be reviewed and merged. + 4. Once the PR is merged, a member of the maintainers team will create & push an appropriate git tag in the format `vX.Y.Z`. + 5. The GitHub Workflow will then build the release and upload it to the [release page](https://github.com/MindWorkAI/AI-Studio/releases/latest). + 6. Building the release including virus scanning takes about 2 1/2 hours.