Update readme.md

+ Updated install instructions for SillyTavern Launcher
This commit is contained in:
deffcolony
2024-06-17 13:04:06 +02:00
committed by GitHub
parent 1d3914324f
commit bca99a4d7f

56
.github/readme.md vendored
View File

@@ -144,12 +144,14 @@ A full list of included extensions and tutorials on how to use them can be found
8. The server will then start, and SillyTavern will pop up in your browser. 8. The server will then start, and SillyTavern will pop up in your browser.
## Installing via SillyTavern Launcher ## Installing via SillyTavern Launcher
1. Install [Git for Windows](https://gitforwindows.org/) 1. On your keyboard: press **`WINDOWS + R`** to open Run dialog box. Then, run the following command to install git:
2. Open Windows Explorer (`Win+E`) and make or choose a folder where you wanna install the launcher to ```shell
3. Open a Command Prompt inside that folder by clicking in the 'Address Bar' at the top, typing `cmd`, and pressing Enter. cmd /c winget install -e --id Git.Git
4. When you see a black box, insert the following command: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git` ```
5. Double-click on `installer.bat` and choose what you wanna install 2. On your keyboard: press **`WINDOWS + E`** to open File Explorer, then navigate to the folder where you want to install the launcher. Once in the desired folder, type `cmd` into the address bar and press enter. Then, run the following command:
6. After installation double-click on `launcher.bat` ```shell
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher && start installer.bat
```
## Installing via GitHub Desktop ## Installing via GitHub Desktop
(This allows git usage **only** in GitHub Desktop, if you want to use `git` on the command line too, you also need to install [Git for Windows](https://gitforwindows.org/)) (This allows git usage **only** in GitHub Desktop, if you want to use `git` on the command line too, you also need to install [Git for Windows](https://gitforwindows.org/))
@@ -183,18 +185,40 @@ For MacOS / Linux all of these will be done in a Terminal.
### For Linux users ### For Linux users
1. Open your favorite terminal and install git 1. Open your favorite terminal and install git
2. Download Sillytavern Launcher with: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git` 2. Git clone the Sillytavern-Launcher with:
3. Navigate to the SillyTavern-Launcher with: `cd SillyTavern-Launcher` ```shell
4. Start the install launcher with: `chmod +x install.sh && ./install.sh` and choose what you wanna install git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher
5. After installation start the launcher with: `chmod +x launcher.sh && ./launcher.sh` ```
3. Start the installer.sh with:
```shell
chmod +x install.sh && ./install.sh
```
4. After installation start the launcher.sh with:
```shell
chmod +x launcher.sh && ./launcher.sh
```
### For Mac users ### For Mac users
1. Open a terminal and install brew with: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` 1. Open a terminal and install brew with:
2. Then install git with: `brew install git` ```shell
3. Download Sillytavern Launcher with: `git clone https://github.com/SillyTavern/SillyTavern-Launcher.git` /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
4. Navigate to the SillyTavern-Launcher with: `cd SillyTavern-Launcher` ```
5. Start the install launcher with: `chmod +x install.sh && ./install.sh` and choose what you wanna install 2. Install git with:
6. After installation start the launcher with: `chmod +x launcher.sh && ./launcher.sh` ```shell
brew install git
```
3. Git clone the Sillytavern-Launcher with:
```shell
git clone https://github.com/SillyTavern/SillyTavern-Launcher.git && cd SillyTavern-Launcher
```
4. Start the installer.sh with:
```shell
chmod +x install.sh && ./install.sh
```
5. After installation start the launcher.sh with:
```shell
chmod +x launcher.sh && ./launcher.sh
```
## 🐋 Installing via Docker ## 🐋 Installing via Docker