Skip to content

Commit

Permalink
Split installation page.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nourepide committed Nov 30, 2023
1 parent e2c15d8 commit 2f59442
Show file tree
Hide file tree
Showing 4 changed files with 187 additions and 200 deletions.
5 changes: 4 additions & 1 deletion Writerside/allor-doc.tree
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
start-page="Introducing.md">

<toc-element topic="Introducing.md"/>
<toc-element topic="Installation.md"/>
<toc-element toc-title="Installation">
<toc-element topic="Installation-ComfyUI.md"/>
<toc-element topic="Installation-Allor.md"/>
</toc-element>
<toc-element topic="Updating.md"/>
<toc-element topic="Configuration.md"/>
<toc-element topic="Node-Naming.md"/>
Expand Down
138 changes: 138 additions & 0 deletions Writerside/topics/Installation-Allor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# Installation Allor

Once **ComfyUI** is installed, you won't have any trouble augmenting it with the **Allor** plugin.

### By Manager

If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) installed, you can install Allor by manager.

### By Download

<tabs group="installing">
<tab title="Installation for Unix" group-key="unix">

<procedure>

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.

</procedure>

</tab>
<tab title="Installation for Windows" group-key="windows">

<procedure>

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.

</procedure>

</tab>
</tabs>

### With Git

<tabs group="installing">
<tab title="Installation for Unix" group-key="unix">

<procedure>

1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory.

You can do this by opening the 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.

</procedure>

</tab>
<tab title="Installation for Windows" group-key="windows">

<procedure>

1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder.

You can do this by pressing <shortcut>Win+R</shortcut> and typing `cmd`.

To change the drive, type the letter of the desired drive followed by a colon.
For example, `D:` will switch you to the D drive.

To move to another folder, use the cd command followed by the folder path.
For example, `cd ComfyUI` will take you to the ComfyUI folder.

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.

</procedure>

</tab>
</tabs>

## 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 yet 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.
Loading

0 comments on commit 2f59442

Please sign in to comment.