From 35707c2dd89a9983f2038ded9bc67d13aa7bc213 Mon Sep 17 00:00:00 2001 From: oobabooga <112222186+oobabooga@users.noreply.github.com> Date: Sun, 17 Aug 2025 21:39:57 -0700 Subject: [PATCH] Update README --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5e7f37de..93d31131 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,13 @@ Its goal is to become the [AUTOMATIC1111/stable-diffusion-webui](https://github. ## How to install -#### Option 1: Portable builds (get started in 1 minute) +#### ✅ Option 1: Portable builds (get started in 1 minute) No installation needed – just download, unzip and run. All dependencies included. Compatible with GGUF (llama.cpp) models on Windows, Linux, and macOS. -Download from here: https://github.com/oobabooga/text-generation-webui/releases +Download from here: **https://github.com/oobabooga/text-generation-webui/releases** #### Option 2: One-click installer @@ -57,23 +57,6 @@ You can pass command-line flags directly (e.g., `./start_linux.sh --help`), or a To update, run the update script for your OS: `update_wizard_windows.bat`, `update_wizard_linux.sh`, or `update_wizard_macos.sh`. -
- -One-click installer details - - -### One-click-installer - -The script uses Miniforge to set up a Conda environment in the `installer_files` folder. - -If you ever need to install something manually in the `installer_files` environment, you can launch an interactive shell using the cmd script: `cmd_linux.sh`, `cmd_windows.bat`, or `cmd_macos.sh`. - -* There is no need to run any of those scripts (`start_`, `update_wizard_`, or `cmd_`) as admin/root. -* To install requirements for extensions, it is recommended to use the update wizard script with the "Install/update extensions requirements" option. At the end, this script will install the main requirements for the project to make sure that they take precedence in case of version conflicts. -* For automated installation, you can use the `GPU_CHOICE`, `LAUNCH_AFTER_INSTALL`, and `INSTALL_EXTENSIONS` environment variables. For instance: `GPU_CHOICE=A LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh`. - -
-
Manual portable installation with venv @@ -108,6 +91,23 @@ deactivate ```
+
+ +One-click installer details + + +### One-click-installer + +The script uses Miniforge to set up a Conda environment in the `installer_files` folder. + +If you ever need to install something manually in the `installer_files` environment, you can launch an interactive shell using the cmd script: `cmd_linux.sh`, `cmd_windows.bat`, or `cmd_macos.sh`. + +* There is no need to run any of those scripts (`start_`, `update_wizard_`, or `cmd_`) as admin/root. +* To install requirements for extensions, it is recommended to use the update wizard script with the "Install/update extensions requirements" option. At the end, this script will install the main requirements for the project to make sure that they take precedence in case of version conflicts. +* For automated installation, you can use the `GPU_CHOICE`, `LAUNCH_AFTER_INSTALL`, and `INSTALL_EXTENSIONS` environment variables. For instance: `GPU_CHOICE=A LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh`. + +
+
Manual full installation with conda or docker