diff --git a/README.md b/README.md index e1a9bbdf..0b9f9216 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ MindWork AI Studio is a desktop application available for macOS, Windows, and Li - **Flexibility**: Choose the provider and model best suited for your current task. - **No bloatware**: The app requires minimal storage for installation and operates with low memory usage. Additionally, it has a minimal impact on system resources, which is beneficial for battery life. -**Ready to get started 🤩?** [Download the appropriate setup for your operating system here](https://github.com/MindWorkAI/AI-Studio/releases/latest). +**Ready to get started 🤩?** [Download the appropriate setup for your operating system here](documentation/Setup.md). ## Support the Project Thank you for using MindWork AI Studio and considering supporting its development 😀. Your support helps keep the project alive and ensures continuous improvements and new features. @@ -35,7 +35,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](https://github.com/MindWorkAI/AI-Studio/releases/latest). This chapter is intended for developers who want to modify and customize the code. +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. diff --git a/documentation/Setup.md b/documentation/Setup.md new file mode 100644 index 00000000..7e36cc6e --- /dev/null +++ b/documentation/Setup.md @@ -0,0 +1,29 @@ +# Install the app +To get started, choose your operating system where you want to install the app: + +- [Windows](#windows) +- [macOS](#macos) +- [Linux](#linux) + +## Windows +AI Studio is only available for modern 64-bit Windows systems. When you have an older 32-bit system, you won't be able to run the app. We require an updated Windows 10 or 11 version; the app won't properly work on Windows 7 or 8. Next, we have to figure out if you have an Intel/AMD or a modern ARM system on your Windows machine. + +- **Copilot Plus PC:** Do you own one of the new Copilot Plus PCs? If so, you most likely have an ARM system. When your machine has a Qualcomm sticker on it, you have an ARM system for sure. [Download the ARM version](https://github.com/MindWorkAI/AI-Studio/releases/latest/download/MindWork%20AI%20Studio_arm64-setup.exe) of AI Studio. +- **Windows on macOS:** Do you run Windows using Parallels on an Apple Silicon system (M1, M2, M3, M4)? Then you have an ARM system as well. [Download the ARM version](https://github.com/MindWorkAI/AI-Studio/releases/latest/download/MindWork%20AI%20Studio_arm64-setup.exe) of AI Studio. +- **Intel/AMD:** In almost all other cases, you have an Intel/AMD system. [Download the x64 version](https://github.com/MindWorkAI/AI-Studio/releases/latest/download/MindWork%20AI%20Studio_x64-setup.exe) of AI Studio. + +When you try to install the app, you get a message regarding protection of your PC. For Windows to trust our app, we need to purchase a certificate that costs around $1000 per year. Would you like to help us with this? [Please consider supporting us](../Sponsors.md). You might want to [visit our release page](https://github.com/MindWorkAI/AI-Studio/releases/latest). There, we provide VirusTotal scan results for each release. If you are unsure about the safety of the app, you can check the results there. When you are confident in the app's safety, click on "More info" and then "Run anyway" to proceed with the installation: + +![Windows Protection](Windows%20Warning%201.png) + +![Windows Protection](Windows%20Warning%202.png) + +## macOS + +MindWork AI Studio_aarch64.dmg +MindWork AI Studio_x64.dmg + +## Linux + +mind-work-ai-studio_amd64.AppImage +mind-work-ai-studio_amd64.deb \ No newline at end of file diff --git a/documentation/Windows Warning 1.png b/documentation/Windows Warning 1.png new file mode 100644 index 00000000..7950818b Binary files /dev/null and b/documentation/Windows Warning 1.png differ diff --git a/documentation/Windows Warning 2.png b/documentation/Windows Warning 2.png new file mode 100644 index 00000000..b7d3623b Binary files /dev/null and b/documentation/Windows Warning 2.png differ