Update readme

This commit is contained in:
cmdr2 2022-08-24 10:58:22 +05:30
parent d73ac65502
commit 27f39fbc70

View File

@ -1,16 +1,17 @@
A simple browser UI for generating images from text prompts, using [Stable Diffusion](https://replicate.com/stability-ai/stable-diffusion). Designed for running locally on your computer. Just enter the text prompt, and see the generated image.
This project is also a quick way to get started with Stable Diffusion. You do not need to have Stable Diffusion already installed, and do not need any API keys. This project will automatically download Stable Diffusion's docker image, the first time it is run.
# What does this do?
Two things:
1. Automatically downloads and installs Stable Diffusion on your local computer (no need to mess with conda or environments)
2. Gives you a simple browser-based UI to talk to your local Stable Diffusion. Enter text prompts and view the generated image. No API keys required.
All the processing will happen on your local computer, it does not transmit your prompts or process on any remote server.
This project runs Stable Diffusion in a docker container behind the scenes, using Stable Diffusion's [official Docker image](https://replicate.com/stability-ai/stable-diffusion) on replicate.com.
![Screenshot of tool](shot.jpg?raw=true)
# System Requirements
1. Requires [Docker](https://docs.docker.com/engine/install/) and [Python](https://www.python.org/downloads/) (3.6 or higher).
2. Linux or Windows 11 (with WSL). Basically if your system can run [Stable Diffusion](https://replicate.com/stability-ai/stable-diffusion).
2. Linux or Windows 11 (with [WSL](https://docs.microsoft.com/en-us/windows/wsl/install)). Basically if your system can run [Stable Diffusion](https://replicate.com/stability-ai/stable-diffusion).
# Installation
1. Download [Quick UI](https://github.com/cmdr2/stable-diffusion-ui/archive/refs/heads/main.zip) (this project)
@ -26,10 +27,15 @@ This project runs Stable Diffusion in a docker container behind the scenes, usin
3. Press `Make Image`. This will take a while, depending on your system's processing power.
4. See the image generated using your prompt. If there's an error, the status message at the top will show 'error' in red.
# Behind the scenes
This project is a quick way to get started with Stable Diffusion. You do not need to have Stable Diffusion already installed, and do not need any API keys. This project will automatically download Stable Diffusion's docker image, the first time it is run.
This project runs Stable Diffusion in a docker container behind the scenes, using Stable Diffusion's [official Docker image](https://replicate.com/stability-ai/stable-diffusion) on replicate.com.
# Bugs reports and code contributions welcome
This was built in a few hours for fun. So if there are any problems, please feel free to file an issue.
Also, if you have any code contributions, please feel to submit a pull request.
Also, please feel free to submit a pull request, if you have any code contributions in mind.
# Disclaimer
I am not responsible for any images generated using this interface.