From 6ea0a7699ec76950851df14a3ca22b1ac0f61f37 Mon Sep 17 00:00:00 2001 From: mauwii Date: Sun, 18 Sep 2022 21:30:18 +0200 Subject: [PATCH] add Icons to Titles and in index.md --- docs/features/CHANGELOG.md | 2 ++ docs/features/CLI.md | 2 ++ docs/features/EMBIGGEN.md | 2 ++ docs/features/IMG2IMG.md | 3 ++- docs/features/INPAINTING.md | 2 ++ docs/features/OTHER.md | 2 ++ docs/features/PROMPTS.md | 6 ++++- docs/features/TEXTUAL_INVERSION.md | 2 ++ docs/features/UPSCALE.md | 2 ++ docs/features/VARIATIONS.md | 4 +++ docs/features/WEB.md | 4 ++- docs/help/TROUBLESHOOT.md | 2 ++ docs/index.md | 38 ++++++++++++++-------------- docs/installation/INSTALL_LINUX.md | 2 ++ docs/installation/INSTALL_MAC.md | 2 ++ docs/installation/INSTALL_WINDOWS.md | 2 ++ docs/other/CONTRIBUTORS.md | 2 ++ 17 files changed, 57 insertions(+), 22 deletions(-) diff --git a/docs/features/CHANGELOG.md b/docs/features/CHANGELOG.md index f50c4f11b8..a6258f6a56 100644 --- a/docs/features/CHANGELOG.md +++ b/docs/features/CHANGELOG.md @@ -2,6 +2,8 @@ title: Changelog --- +# :octicons-log-16: Changelog + ## v1.13 (in process) - Supports a Google Colab notebook for a standalone server running on Google diff --git a/docs/features/CLI.md b/docs/features/CLI.md index 2ff4d4894f..7c3dae4a5a 100644 --- a/docs/features/CLI.md +++ b/docs/features/CLI.md @@ -4,6 +4,8 @@ hide: - toc --- +# :material-bash: CLI + ## **Interactive Command Line Interface** The `dream.py` script, located in `scripts/dream.py`, provides an interactive interface to image diff --git a/docs/features/EMBIGGEN.md b/docs/features/EMBIGGEN.md index 16acd36cba..aecebf04e8 100644 --- a/docs/features/EMBIGGEN.md +++ b/docs/features/EMBIGGEN.md @@ -2,6 +2,8 @@ title: Embiggen --- +# :material-loupe: Embiggen + **upscale your images on limited memory machines** GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid diff --git a/docs/features/IMG2IMG.md b/docs/features/IMG2IMG.md index eeaecbf981..e61f365c01 100644 --- a/docs/features/IMG2IMG.md +++ b/docs/features/IMG2IMG.md @@ -2,7 +2,8 @@ title: Image-to-Image --- -## **IMG2IMG** +# :material-image-multiple: **IMG2IMG** + This script also provides an `img2img` feature that lets you seed your creations with an initial drawing or photo. This is a really cool feature that tells stable diffusion to build the prompt on top of the image you provide, preserving the original's basic shape and layout. To use it, provide diff --git a/docs/features/INPAINTING.md b/docs/features/INPAINTING.md index a6c7f53500..98c708f798 100644 --- a/docs/features/INPAINTING.md +++ b/docs/features/INPAINTING.md @@ -2,6 +2,8 @@ title: Inpainting --- +# :octicons-paintbrush-16: Inpainting + ## **Creating Transparent Regions for Inpainting** Inpainting is really cool. To do it, you start with an initial image and use a photoeditor to make diff --git a/docs/features/OTHER.md b/docs/features/OTHER.md index 019ed35b70..5faa1d32d0 100644 --- a/docs/features/OTHER.md +++ b/docs/features/OTHER.md @@ -2,6 +2,8 @@ title: Others --- +# :fontawesome-regular-share-from-square: Others + ## **Google Colab** Stable Diffusion AI Notebook:
-# Stable Diffusion Dream Script +# :material-script-text-outline: Stable Diffusion Dream Script ![project logo](assets/logo.png) @@ -55,29 +55,29 @@ GPU cards with as little as 4 GB or RAM. [Issues](https://github.com/lstein/stable-diffusion/issues) tab to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster. -## Installation +## :octicons-package-dependencies-24: Installation This fork is supported across multiple platforms. You can find individual installation instructions below. -- [Linux](installation/INSTALL_LINUX.md) -- [Windows](installation/INSTALL_WINDOWS.md) -- [Macintosh](installation/INSTALL_MAC.md) +- :fontawesome-brands-linux: [Linux](installation/INSTALL_LINUX.md) +- :fontawesome-brands-windows: [Windows](installation/INSTALL_WINDOWS.md) +- :fontawesome-brands-apple: [Macintosh](installation/INSTALL_MAC.md) -## Hardware Requirements +## :fontawesome-solid-computer: Hardware Requirements -### System +### :octicons-cpu-24: System You wil need one of the following: -- An NVIDIA-based graphics card with 4 GB or more VRAM memory. -- An Apple computer with an M1 chip. +- :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory. +- :fontawesome-brands-apple: An Apple computer with an M1 chip. -### Memory +### :fontawesome-solid-memory: Memory - At least 12 GB Main Memory RAM. -### Disk +### :fontawesome-regular-hard-drive: Disk - At least 6 GB of free disk space for the machine learning model, Python, and all its dependencies. @@ -94,7 +94,7 @@ You wil need one of the following: (ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision ``` -## Features +## :octicons-list-unordered-24: Features ### Major Features @@ -117,7 +117,7 @@ You wil need one of the following: - [Creating Transparent Regions for Inpainting](features/INPAINTING.md#creating-transparent-regions-for-inpainting) - [Preload Models](features/OTHER.md#preload-models) -## Latest Changes +## :octicons-log-16: Latest Changes ### v1.14 (11 September 2022) @@ -148,12 +148,12 @@ You wil need one of the following: For older changelogs, please visit the **[CHANGELOG](features/CHANGELOG.md)**. -## Troubleshooting +## :material-target: Troubleshooting -Please check out our **[Q&A](help/TROUBLESHOOT.md)** to get solutions for common installation +Please check out our **[:material-frequently-asked-questions: Q&A](help/TROUBLESHOOT.md)** to get solutions for common installation problems and other issues. -## Contributing +## :octicons-repo-push-24: Contributing Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so. If you are unfamiliar with how @@ -165,13 +165,13 @@ important thing is to **make your pull request against the "development" branch* "main". This will help keep public breakage to a minimum and will allow you to propose more radical changes. -## Contributors +## :octicons-person-24: Contributors This fork is a combined effort of various people from across the world. [Check out the list of all these amazing people](other/CONTRIBUTORS.md). We thank them for their time, hard work and effort. -## Support +## :octicons-question-24: Support For support, please use this repository's GitHub Issues tracking service. Feel free to send me an email if you use and like the script. @@ -179,7 +179,7 @@ email if you use and like the script. Original portions of the software are Copyright (c) 2020 [Lincoln D. Stein](https://github.com/lstein) -## Further Reading +## :octicons-book-24: Further Reading Please see the original README for more information on this software and underlying algorithm, located in the file [README-CompViz.md](other/README-CompViz.md). diff --git a/docs/installation/INSTALL_LINUX.md b/docs/installation/INSTALL_LINUX.md index 4b9be84542..a871c226e6 100644 --- a/docs/installation/INSTALL_LINUX.md +++ b/docs/installation/INSTALL_LINUX.md @@ -2,6 +2,8 @@ title: Linux --- +# :fontawesome-brands-linux: Linux + ## Installation 1. You will need to install the following prerequisites if they are not already diff --git a/docs/installation/INSTALL_MAC.md b/docs/installation/INSTALL_MAC.md index ec5b660d36..d45a1140af 100644 --- a/docs/installation/INSTALL_MAC.md +++ b/docs/installation/INSTALL_MAC.md @@ -2,6 +2,8 @@ title: macOS --- +# :fontawesome-brands-apple: macOS + ## Requirements - macOS 12.3 Monterey or later diff --git a/docs/installation/INSTALL_WINDOWS.md b/docs/installation/INSTALL_WINDOWS.md index e9e58c5e5e..d0f6355bb2 100644 --- a/docs/installation/INSTALL_WINDOWS.md +++ b/docs/installation/INSTALL_WINDOWS.md @@ -2,6 +2,8 @@ title: Windows --- +# :fontawesome-brands-windows: Windows + ## **Notebook install (semi-automated)** We have a diff --git a/docs/other/CONTRIBUTORS.md b/docs/other/CONTRIBUTORS.md index 7eba44dbad..dcea33492a 100644 --- a/docs/other/CONTRIBUTORS.md +++ b/docs/other/CONTRIBUTORS.md @@ -2,6 +2,8 @@ title: Contributors --- +# :octicons-person-24: Contributors + The list of all the amazing people who have contributed to the various features that you get to experience in this fork.