diff --git a/Writerside/images/documentation.png b/Writerside/images/documentation.png new file mode 100644 index 0000000..51abd9a Binary files /dev/null and b/Writerside/images/documentation.png differ diff --git a/Writerside/topics/Allor-Doc.md b/Writerside/topics/Allor-Doc.md index 607549b..e38b155 100644 --- a/Writerside/topics/Allor-Doc.md +++ b/Writerside/topics/Allor-Doc.md @@ -1,3 +1,21 @@ # About Allor +![logo](documentation.png) +> Welcome to `ComfyUI Allor Documentation`. Now you are ready for a new big step. + +## Introducing Allor + +**Allor**, is a plugin for **ComfyUI**, is your go-to solution for image post-processing. Here's why: + +- **Transparency Support**: Allor fully supports RGBA, ensuring your images maintain their quality and integrity. + +- **Batch Processing**: Have multiple images to process? No problem. Allor can handle batch image processing with ease. + +- **Versatile Modules**: With over 100+ nodes spread across various modules, Allor is equipped to handle a wide range of tasks. + +- **Customizable**: Tailor Allor to your needs. From modules to fonts, you have the freedom to configure it as you see fit. + +- **Self-Updating**: To provide you with the latest features and improvements, Allor has the ability to update itself. + +Now you are ready for Installing stage. diff --git a/Writerside/topics/Alpha-Chanel.md b/Writerside/topics/Alpha-Chanel.md index 3423a52..138dac5 100644 --- a/Writerside/topics/Alpha-Chanel.md +++ b/Writerside/topics/Alpha-Chanel.md @@ -1,3 +1,3 @@ # Alpha Chanel -![alpha_chanel](alpha_chanel.png) +![alpha_chanel](alpha_chanel.png){ border-effect="rounded" } diff --git a/Writerside/topics/Installation.md b/Writerside/topics/Installation.md index 25267fe..e5273f6 100644 --- a/Writerside/topics/Installation.md +++ b/Writerside/topics/Installation.md @@ -1 +1,119 @@ # Installation + +> Before installing Allor, you need to have ComfyUI installed, +> see [here](https://github.com/comfyanonymous/ComfyUI#installing) how it can be done. +> {style="note"} + +## Requirements +* ComfyUI +* Python 3.10 or above + +## Installing with manager + +If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) installed you can just install Allor by +manager. + +## Installing with direct download + + + + +1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip). + +2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI/custom_nodes` directory. + +3. **Run the Installation Script**: Execute the `install.sh` file. You can do this from the terminal with the following command: + + ```bash + bash install.sh + ``` + +4. **Run ComfyUI**: Finally, run ComfyUI. + + + + +1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip). + +2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI\custom_nodes` directory. + +3. **Run the Installation Script**: Execute the `install.bat` file. You can do this from the command prompt with the following command or just click on it: + + ```bash + install.bat + ``` + +4. **Run ComfyUI**: Finally, run ComfyUI. + + + + +## Installing with Git + + + + +1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory. You can do this by opening Terminal and using + the `cd` command. + +2. **Clone the Repository**: Clone the repository by entering the following command: + + ```bash + git clone https://github.com/Nourepide/ComfyUI-Allor.git + ``` + +3. **Navigate to the Allor Folder**: Enter the Allor folder using the following command: + + ```bash + cd ComfyUI-Allor + ``` + +4. **Run the Installation Script**: Execute the `install.bat` script by entering the following command: + + ```bash + bash install.sh + ``` + +5. **Run ComfyUI**: Finally, run ComfyUI. + + + + +1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder. You can do this by pressing + Win+R, typing `cmd`, and pressing Enter. + +2. **Clone the Repository**: Clone the repository by entering the following command: + + ```bash + git clone https://github.com/Nourepide/ComfyUI-Allor.git + ``` + +3. **Navigate to the Allor Folder**: Enter the Allor folder using the following command: + + ```bash + cd ComfyUI-Allor + ``` + +4. **Run the Installation Script**: Execute the `install.bat` script by entering the following command: + + ```bash + install.bat + ``` + +5. **Run ComfyUI**: Finally, run ComfyUI. + + + + +## What does the installation script do? + +1. **Searches for the virtual environment**: The script checks for a Python virtual environment. + +2. **Installs dependencies**: If a `requirements.txt` file exists in the current directory, the script installs the dependencies listed in it. + +3. **Initializes a Git repository**: If Git is installed and the current directory is not already a Git repository, the script initializes a new Git repository and syncs it with a remote repository. + +4. **Uses GitPython**: If Git is not installed, the script uses GitPython, a Python library, to perform Git operations. + +5. **Finishes its work**: Finally, the script deactivates the Python virtual environment. + diff --git a/Writerside/topics/Updating.md b/Writerside/topics/Updating.md index d0b9157..a67889e 100644 --- a/Writerside/topics/Updating.md +++ b/Writerside/topics/Updating.md @@ -1 +1,38 @@ # Updating + +## Auto-Update + +**Allor** has the capability to **self-update**. By default, this happens **once a day**. + +If you wish to **modify this behavior** or **disable auto-update**, please refer to the **configuration page**. + +## Manual updating with Git + +> You need to have Git installed. + + + + +1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes/ComfyUI-Allor` directory. You can do this by opening Terminal and using + the `cd` command. + +2. **Update the Repository**: Update the repository by entering the following command: + + ```bash + git pull + ``` + + + + +1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes\ComfyUI-Allor` folder. You can do this by pressing + Win+R, typing `cmd`, and pressing Enter. + +2. **Update the Repository**: Update the repository by entering the following command: + + ```bash + git pull + ``` + + +