Skip to content

Commit

Permalink
docs: add features section
Browse files Browse the repository at this point in the history
  • Loading branch information
wy-luke committed Aug 27, 2023
1 parent 747dcbf commit 1979128
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 14 deletions.
50 changes: 43 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,56 @@

Assist you in **quickly and effortlessly** installing the Stable Diffusion web UI on your Mac.

---
## Features

Steps:
1. Use [Homebrew](https://brew.sh/) to install required dependencies. If you already have it installed, it will be used automatically. If not, it will be installed for you, but without modifying your system environment – your system will remain unchanged.

If you wish to activate it by default, you can add `eval $(/opt/homebrew/bin/brew shellenv)` to your `.zprofile` (zsh) or `.bash_profile` (bash) file.

You could also:

```bash
# zsh
echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> /Users/$USER/.zprofile
eval $(/opt/homebrew/bin/brew shellenv)

# bash
echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> /Users/$USER/.bash_profile
eval $(/opt/homebrew/bin/brew shellenv)
```

2. Use [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html), which is a tiny version of the [mamba](https://mamba.readthedocs.io/en/latest/index.html#), as python related package and environment manager instead of Conda.

Compared to Conda, it has no base environment (empty) nor default version of Python, meaning that it won't interfere or contaminate your system's Python environment at all. Additionally, it's significantly faster.

Similarly, it isn't added to the system environment either, and won't be activated automatically by default.

But if you want, you could:

```bash
# zsh
/opt/homebrew/bin/micromamba shell init -s zsh -p ~/micromamba
source ~/.zshrc

# bash
/opt/homebrew/bin/micromamba shell init -s bash -p ~/micromamba
source ~/.bashrc
```

## Steps

1. In the **Applications** folder, locate **Terminal** <img src="./images/terminal.png" alt="terminal" width="25"/> and open it.

1. In the **Applications** folder, locate **Terminal** <img src="./images/terminal.png" alt="terminal" width="25"/> and open it.
2. Copy the following command to the **terminal**, press the **Enter key** to execute the command, and the installation will start automatically. Just wait for the installation to complete.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wy-luke/StableDiffusion-Installer-For-Mac/main/sd-installer.sh)"
```
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wy-luke/StableDiffusion-Installer-For-Mac/main/sd-installer.sh)"
```

3. ~~If prompted to input, simply press the **Enter key** and **only** that.~~

4. If you see similar content below, it indicates a successful installation.

![success](images/success.png)
![success](images/success.png)

5. Open your web browser and enter `http://127.0.0.1:7860` (the underlined part in the image above) to access the Stable Diffusion web UI.
46 changes: 39 additions & 7 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,52 @@

帮助你**快速、轻松**地将 Stable Diffusion web UI 安装在你的 mac 上。

---
## 特性

使用步骤:
1. 使用 [Homebrew](https://brew.sh/) 来安装所需的依赖。如果已经安装,将会自动使用;如果没有,将会自动安装,但不会修改你的系统环境,你的系统将保持不变。

1.**应用程序**中,找到**终端** <img src="./images/terminal.png" alt="terminal" width="25"/> 并打开
如果你希望默认激活使用它,可以将 `eval $(/opt/homebrew/bin/brew shellenv)` 添加到 `.zprofile`(zsh)或 `.bash_profile`(bash)文件中。

你也可以使用一下命令:

```bash
# zsh
echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> /Users/$USER/.zprofile
eval $(/opt/homebrew/bin/brew shellenv)

# bash
echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> /Users/$USER/.bash_profile
eval $(/opt/homebrew/bin/brew shellenv)
```

2. 使用 [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)[mamba](https://mamba.readthedocs.io/en/latest/index.html#) 的精简版本)作为 Python 的包和环境管理工具,而不是 Conda。

与 Conda 相比,它没有 `base` 环境(为空),也没有默认的 Python 版本,这意味着它不会干扰或污染你的系统 Python 环境。此外,它的速度更快。

同样地,它也不会被添加到你的系统环境中,不会被自动激活。但如果你想要的话,可以使用以下命令:

```bash
# zsh
/opt/homebrew/bin/micromamba shell init -s zsh -p ~/micromamba
source ~/.zshrc

# bash
/opt/homebrew/bin/micromamba shell init -s bash -p ~/micromamba
source ~/.bashrc
```

## 使用

1.**应用程序**中,找到**终端** <img src="./images/terminal.png" alt="terminal" width="25"/> 并打开
2. 复制下面的命令到**终端**中,按**回车键**执行命令,然后安装就会自动开始,只需等待安装完成

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wy-luke/StableDiffusion-Installer-For-Mac/main/sd-installer.sh)"
```
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/wy-luke/StableDiffusion-Installer-For-Mac/main/sd-installer.sh)"
```

3. ~~如果提示输入,需且**只需****回车键**~~
4. 如果出现类似下面的内容,即为安装成功

![success](images/success.png)
![success](images/success.png)

5. 打开浏览器,输入 `http://127.0.0.1:7860`(即上图划线部分),即可打开 Stable Diffusion web UI

0 comments on commit 1979128

Please sign in to comment.