From 1822242b3f202f8902b2ef7701bf2d6ddfd804c8 Mon Sep 17 00:00:00 2001 From: QuantumSoul Date: Sat, 8 Jul 2023 14:27:29 +0200 Subject: [PATCH 1/3] Update README.md - Fix typos - Add trailing dots - Fix formatting --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index eb9bcbac2..6464e5a93 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ **Stable Diffusion implementation with modern UI and advanced features** -This project started as a form from [Automatic1111 WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) and it grew siginificantly since then, but although it diverged significanly, any substantial features to original work is ported to this repository as well +This project started as a fork from [Automatic1111 WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) and it grew significantly since then, but although it diverged considerably, any substantial features to original work is ported to this repository as well. -Individual features are not listed here, instead check [Changelog](CHANGELOG.md) for full list of changes +Individual features are not listed here, instead check [Changelog](CHANGELOG.md) for full list of changes. ## Platform support @@ -32,12 +32,13 @@ Individual features are not listed here, instead check [Changelog](CHANGELOG.md) `webui.bat` or `webui.sh`: - Platform specific wrapper scripts For Windows, Linux and OSX - Starts `sdnext.py` in a Python virtual environment (`venv`) - - Uses `install.py` to handle all actual requirements and dependencies - - *Note*: Server can run without virtual environment, but it is recommended to use it to avoid library version conflicts with other applications + - Uses `install.py` to handle all actual requirements and dependencies -*Note*: **nVidia/CUDA** and **AMD/ROCm** are auto-detected is present and available, but for any other use case specify required parameter explicitly or wrong packages may be installed as installer will assume CPU-only environment +*Note*: Server can run without virtual environment, but it is recommended to use it to avoid library version conflicts with other applications -Full startup sequence is logged in `sdnext.log`, so if you encounter any issues, please check it first +*Note*: **nVidia/CUDA** and **AMD/ROCm** are auto-detected is present and available, but for any other use case specify required parameter explicitly or wrong packages may be installed as installer will assume CPU-only environment. + +Full startup sequence is logged in `sdnext.log`, so if you encounter any issues, please check it first. Below is partial list of all available parameters, run `webui --help` for the full list: @@ -64,14 +65,16 @@ Below is partial list of all available parameters, run `webui --help` for the fu ### **Collab** - To avoid having this repo rely just on me, I'd love to have additional maintainers with full admin rights. If you're interested, ping me! -- In addition to general cross-platform code, desire is to have a lead for each of the main platforms -This should be fully cross-platform, but I would really love to have additional contibutors and/or maintainers to join and help lead the efforts on different platforms +- In addition to general cross-platform code, desire is to have a lead for each of the main platforms. +This should be fully cross-platform, but I would really love to have additional contibutors and/or maintainers to join and help lead the efforts on different platforms. ### **Goals** -The idea behind the fork is to enable latest technologies and advances in text-to-image generation -*Sometimes this is not the same as "as simple as possible to use"* -If you are looking an amazing simple-to-use Stable Diffusion tool, I'd suggest [InvokeAI](https://invoke-ai.github.io/InvokeAI/) specifically due to its automated installer and ease of use +The idea behind the fork is to enable latest technologies and advances in text-to-image generation. + +*Sometimes this is not the same as "as simple as possible to use".* + +If you are looking an amazing simple-to-use Stable Diffusion tool, I'd suggest [InvokeAI](https://invoke-ai.github.io/InvokeAI/) specifically due to its automated installer and ease of use. General goals: From 7e665ab5c0eda460b4d75e40e84fb8dd7343d62a Mon Sep 17 00:00:00 2001 From: QuantumSoul Date: Sat, 8 Jul 2023 15:03:52 +0200 Subject: [PATCH 2/3] Beautiful README.md formatting --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6464e5a93..953a5c268 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ -[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/vladmandic) -![Last Commit](https://img.shields.io/github/last-commit/vladmandic/automatic?style=flat-square&svg=true) -![License](https://img.shields.io/github/license/vladmandic/automatic?style=flat-square&svg=true) -![GitHub Status Checks](https://img.shields.io/github/checks-status/vladmandic/automatic/main?style=flat-square&svg=true) -![Discord](https://img.shields.io/discord/1101998836328697867) - +
+ # SD.Next +**🫧 Stable Diffusion implementation with modern UI and advanced features 🫧** +
+[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/vladmandic) +![Last Commit](https://img.shields.io/github/last-commit/vladmandic/automatic?svg=true) +![License](https://img.shields.io/github/license/vladmandic/automatic?svg=true) +![GitHub Status Checks](https://img.shields.io/github/checks-status/vladmandic/automatic/main?svg=true) +[![Discord](https://img.shields.io/discord/1101998836328697867?logo=Discord&svg=true)](https://discord.gg/VjvR2tabEX) -**Stable Diffusion implementation with modern UI and advanced features** +### [Docs](README.md#docs) | [Discord](https://discord.gg/VjvR2tabEX) | [Changelog](CHANGELOG.md) + +
This project started as a fork from [Automatic1111 WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) and it grew significantly since then, but although it diverged considerably, any substantial features to original work is ported to this repository as well. @@ -34,9 +39,9 @@ Individual features are not listed here, instead check [Changelog](CHANGELOG.md) - Starts `sdnext.py` in a Python virtual environment (`venv`) - Uses `install.py` to handle all actual requirements and dependencies -*Note*: Server can run without virtual environment, but it is recommended to use it to avoid library version conflicts with other applications +> Server can run without virtual environment, but it is recommended to use it to avoid library version conflicts with other applications -*Note*: **nVidia/CUDA** and **AMD/ROCm** are auto-detected is present and available, but for any other use case specify required parameter explicitly or wrong packages may be installed as installer will assume CPU-only environment. +> **nVidia/CUDA** and **AMD/ROCm** are auto-detected is present and available, but for any other use case specify required parameter explicitly or wrong packages may be installed as installer will assume CPU-only environment. Full startup sequence is logged in `sdnext.log`, so if you encounter any issues, please check it first. @@ -72,7 +77,7 @@ This should be fully cross-platform, but I would really love to have additional The idea behind the fork is to enable latest technologies and advances in text-to-image generation. -*Sometimes this is not the same as "as simple as possible to use".* +> *Sometimes this is not the same as "as simple as possible to use".* If you are looking an amazing simple-to-use Stable Diffusion tool, I'd suggest [InvokeAI](https://invoke-ai.github.io/InvokeAI/) specifically due to its automated installer and ease of use. @@ -98,6 +103,7 @@ General goals: ### **Docs** +- [Wiki](https://github.com/vladmandic/automatic/wiki) - [ReadMe](README.md) - [ToDo](TODO.md) - [Changelog](CHANGELOG.md) From 9dd1ce837a7be04183db178e14e40c0c82a59fc5 Mon Sep 17 00:00:00 2001 From: QuantumSoul Date: Sat, 8 Jul 2023 15:38:54 +0200 Subject: [PATCH 3/3] README.md title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 953a5c268..c4e55125d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
# SD.Next -**🫧 Stable Diffusion implementation with modern UI and advanced features 🫧** +**Stable Diffusion implementation with advanced features**
[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/vladmandic) ![Last Commit](https://img.shields.io/github/last-commit/vladmandic/automatic?svg=true)