-# ๐ Quick Start
+# ๐ Installation
-You'll need to have [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) installed. Then run the following commands to install dependencies and launch StableStudio.
-
-```bash
-git clone https://github.com/Stability-AI/StableStudio.git
-```
-
-```bash
-cd StableStudio
-```
-
-```bash
-yarn
-```
-
-```bash
-yarn dev
-```
+You'll need to head over to the [Releases](https://github.com/Stability-AI/StableStudio/releases) page to download StableStudio for your operating system. StableStudio will download and install its own managed copy of [ComfyUI](https://github.com/comfyanonymous/ComfyUI) and the Stable Diffusion weights.
_**That's it! ๐**_
-StableStudio will be running at [localhost:3000](http://localhost:3000) by default.
-
-> If you are using the default Stability API plugin, You'll need to have your [API key](https://platform.stability.ai/docs/getting-started/authentication) handy. Otherwise, you should be good to go!
-
-# About
+# About
-
+
-StableStudio is [Stability AI](https://stability.ai)'s official open-source variant of [DreamStudio](https://www.dreamstudio.ai), our user interface for generative AI. It is a web-based application that allows users to create and edit generated images. We're not entirely sure where this project is going just yet, but we're excited to see what the community does with it!
+StableStudio is [Stability AI](https://stability.ai)'s official open-source variant of [DreamStudio](https://www.dreamstudio.ai), our user interface for generative AI. It is a desktop application for local inference of Stable Diffusion that allows users to create and edit generated images. We're excited to see what the community does with it!
-# FAQ
+# FAQ
### What's the difference between StableStudio and [DreamStudio](https://dreamstudio.ai)?
@@ -59,9 +36,9 @@ _Not much!_ There are a few tweaks we made to make the project more community-fr
- We removed [DreamStudio](https://dreamstudio.ai)-specific branding.
-- All "over-the-wire" API calls have been replaced by a [plugin system](./packages/stablestudio-plugin/README.md) which allows you to easily swap out the back-end.
+- StableStudio is now packaged as a tauri application
- - With a little bit of TypeScript, you can [create your own plugin](./packages/stablestudio-plugin/README.md) and use StableStudio with any back-end you want!
+- All "over-the-wire" API calls have been replaced by a [ComfyUI](https://github.com/comfyanonymous/ComfyUI) backend.
- We removed Stability-specific account features such as billing, API key management, etc.
@@ -69,12 +46,41 @@ _Not much!_ There are a few tweaks we made to make the project more community-fr
### Will [DreamStudio](https://dreamstudio.ai) still be supported?
-_Yes!_ Stability's hosted deployment of StableStudio will remain [DreamStudio](https://dreamstudio.ai). It will continue to get updates and stay up-to-date with StableStudio whenever possible.
+_Yes!_ Stability's hosted deployment of StableStudio will remain [DreamStudio](https://dreamstudio.ai).
-# ๐งโ๐ป Contributing
+# Building From Source
+
+> Make sure you have the rust toolchain, nodejs, and yarn installed
+
+1. Clone the repo
+
+```
+git clone https://github.com/Stability-AI/StableStudio
+```
+
+2. Install yarn dependencies
+
+```
+yarn install
+```
+
+3. Build
+
+```
+cargo tauri build
+```
+> Or for development
+
+```
+cargo tauri dev
+```
+
+Installers/executables should be located in `packages/stablestudio-ui/src-tauri/target/release/bundle`
+
+# Contributing
-
-
-
+ 
+ 