diff --git a/README.md b/README.md index 8321789..3701f93 100644 --- a/README.md +++ b/README.md @@ -26,27 +26,13 @@ This program acts primarily as a command generator for **stable-diffusion.cpp**, ## Installation and Running ### Dependencies - - Git - - Python - -### Steps -1. Clone the repository: -```bash -git clone https://github.com/daniandtheweb/sd.cpp-webui.git -``` -2. Clone `stable-diffusion.cpp`: -```bash -git clone https://github.com/leejet/stable-diffusion.cpp.git -``` -3. Follow the instructions in **stable-diffusion.cpp**`s folder to build the project. -4. Copy the built file (`sd` or `sd.exe`) from the `build/bin` directory to the `sd.cpp-webui` folder. -5. On Linux/macOS, ensure the copied file is executable. -6. Run the launch script: - - `sdcpp_webui.sh` for Linux/macOS - - `sdcpp_webui_windows.bat` for Windows - - -For more information on available launch arguments, run the script with `-h` or `--help`. + +- Python (3.13 on Windows) +- Git (Recommended) + +### Setup + +Just run [`sdcpp_webui.sh`](https://github.com/daniandtheweb/sd.cpp-webui/blob/master/docs/linux.md) for Linux/MacOS or [`sdcpp_webui_windows.ps1`](https://github.com/daniandtheweb/sd.cpp-webui/blob/master/docs/windows.md) for Windows. ![swappy-20240904-145835](https://github.com/user-attachments/assets/78c52f9e-f6f7-454d-aa77-b3288571fe4e) diff --git a/docs/linux.md b/docs/linux.md new file mode 100644 index 0000000..c7d9f46 --- /dev/null +++ b/docs/linux.md @@ -0,0 +1,40 @@ +# Setup instructions for Linux + +## Dependencies: + +- Python +- Git (Recommended) + +## Setup: + +1. Clone the repository with Git: + + ```bash + git clone https://github.com/daniandtheweb/sd.cpp-webui.git + ``` + +3. Move inside of `sd.cpp-webui`'s directory: + + ```bash + cd sd.cpp-webui + ``` + +4. Execute the launch script, this will automatically create a virtual environment and install all the necessary Python packages: + + ```bash + ./sdcpp_webui.sh --autostart + ``` + +- To see all available arguments and options, run: + + ```bash + ./sdcpp_webui.sh --help + ``` + +## Updating the WebUI: + +1. Inside of `sd.cpp-webui`'s directory run: + + ```bash + git pull + ``` diff --git a/docs/windows.md b/docs/windows.md new file mode 100644 index 0000000..9c839f8 --- /dev/null +++ b/docs/windows.md @@ -0,0 +1,79 @@ +# Setup instructions for Windows + +## Dependencies: + +- Python 3.13 (3.14 is currently unsupported) +- Git (Recommended) + +### Python install: + +1. Open Terminal (PowerShell) + +2. Paste this and press enter to install Python 3.13: + + ```powershell + winget install --id=Python.Python.3.13 -e + ``` + +### Git install (optional): + +1. Open Terminal (PowerShell) + +2. Paste this and press enter to install Git: + + ```powershell + winget install --id=Git.Git -e + ``` + +## Setup: + +- Using Terminal (PowerShell): + +0. Ensure that execution of scripts is allowed (this is just required to run the `sdcpp_webui_windows.ps1` script; I'm not responsable for any other scripts that you may run in your system. You're encouraged to ALWAYS read the content of a script, even this, before executing it). + + - Run PowerShell as an Administrator and execute this: + + ```powershell + Set-ExecutionPolicy Unrestricted -Scope CurrentUser + ``` + + - Close PowerShell Administrator. + +1. Get the code using one of the following methods: +- 1A: Clone the repository with Git (recommended): + + - Open Terminal (PowerShell) in a location of your choice and run: + + ```powershell + git clone https://github.com/daniandtheweb/sd.cpp-webui + ``` + +- 1B: Manual Download + + - [Download](https://www.google.com/search?q=https://github.com/daniandtheweb/sd.cpp-webui/archive/refs/heads/main.zip) and extract in a location of your choice (e.g., your Desktop). + +2. Move inside of `sd.cpp-webui`'s directory: + + ```powershell + cd sd.cpp-webui + ``` + +3. Execute the launch script, this will automatically create a virtual environment and install all the necessary Python packages: + + ```powershell + .\sdcpp_webui_windows.ps1 --autostart + ``` + +- To see all available arguments and options, run: + + ```powershell + .\sdcpp_webui_windows.ps1 --help + ``` + +## Updating the WebUI: + +1. Open Terminal (PowerShell) inside of `sd.cpp-webui`'s directory and execute this: + + ```powershell + git pull + ```