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: