Update readme (#897)

Author: Naozumi520

README.md

@@ -44,17 +44,21 @@
 + 使用最先进的[人声音高提取算法InterSpeech2023-RMVPE](#参考项目)根绝哑音问题。效果最好（显著地）但比crepe_full更快、资源占用更小
 
 ## 环境配置
-可以使用poetry配置环境。
+以下指令需在 Python 版本大于3.8的环境中执行。  
 
-以下指令需在Python版本大于3.8的环境中执行:
+(Windows/Linux)  
+首先通过 pip 安装主要依赖:
 ```bash
 # 安装Pytorch及其核心依赖，若已安装则跳过
 # 参考自: https://pytorch.org/get-started/locally/
 pip install torch torchvision torchaudio
 
 #如果是win系统+Nvidia Ampere架构(RTX30xx)，根据 #21 的经验，需要指定pytorch对应的cuda版本
 #pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117
+```
 
+可以使用 poetry 来安装依赖：
+```bash
 # 安装 Poetry 依赖管理工具, 若已安装则跳过
 # 参考自: https://python-poetry.org/docs/#installation
 curl -sSL https://install.python-poetry.org | python3 -
@@ -63,11 +67,17 @@ curl -sSL https://install.python-poetry.org | python3 -
 poetry install
 ```
 
-你也可以通过pip来安装依赖：
+你也可以通过 pip 来安装依赖：
 ```bash
 pip install -r requirements.txt
 ```
 
+------
+Mac 用户可以通过 `run.sh` 来安装依赖：
+```bash
+sh ./run.sh
+```
+
 ## 其他预模型准备
 RVC需要其他一些预模型来推理和训练。
 
@@ -85,7 +95,7 @@ hubert_base.pt
 
 ./pretrained_v2 
 
-如果你正在使用Windows，则你可能需要这个文件，若ffmpeg和ffprobe已安装则跳过; ubuntu/debian 用户可以通过apt install ffmpeg来安装这2个库
+如果你正在使用Windows，则你可能需要这个文件，若ffmpeg和ffprobe已安装则跳过; ubuntu/debian 用户可以通过apt install ffmpeg来安装这2个库, Mac 用户则可以通过brew install ffmpeg来安装 (需要预先安装brew)
 
 ./ffmpeg
 
@@ -104,7 +114,8 @@ https://huggingface.co/lj1995/VoiceConversionWebUI/blob/main/rmvpe.pt
 ```bash
 python infer-web.py
 ```
-如果你正在使用Windows，你可以直接下载并解压`RVC-beta.7z`，运行`go-web.bat`以启动WebUI。
+
+如果你正在使用Windows 或 macOS，你可以直接下载并解压`RVC-beta.7z`，前者可以运行`go-web.bat`以启动WebUI，后者则运行命令`sh ./run.sh`以启动WebUI。
 
 仓库内还有一份`小白简易教程.doc`以供参考。
 

docs/README.en.md

@@ -35,37 +35,49 @@ Realtime Voice Conversion Software using RVC : [w-okada/voice-changer](https://g
 
 ## Summary
 This repository has the following features:
-+ Reduce tone leakage by replacing source feature to training-set feature using top1 retrieval;
++ Reduce tone leakage by replacing the source feature to training-set feature using top1 retrieval;
 + Easy and fast training, even on relatively poor graphics cards;
 + Training with a small amount of data also obtains relatively good results (>=10min low noise speech recommended);
 + Supporting model fusion to change timbres (using ckpt processing tab->ckpt merge);
 + Easy-to-use Webui interface;
 + Use the UVR5 model to quickly separate vocals and instruments.
++ Use the most powerful High-pitch Voice Extraction Algorithm [InterSpeech2023-RMVPE](#Credits) to prevent the muted sound problem. Provides the best results (significantly) and is faster, with even lower resource consumption than Crepe_full.
+
 ## Preparing the environment
-We recommend you install the dependencies through poetry.
+The following commands need to be executed in the environment of Python version 3.8 or higher.
 
-The following commands need to be executed in the environment of Python version 3.8 or higher:
+(Windows/Linux)
+First install the main dependencies through pip:
 ```bash
 # Install PyTorch-related core dependencies, skip if installed
 # Reference: https://pytorch.org/get-started/locally/
 pip install torch torchvision torchaudio
 
 #For Windows + Nvidia Ampere Architecture(RTX30xx), you need to specify the cuda version corresponding to pytorch according to the experience of https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/issues/21
 #pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117
+```
 
+Then can use poetry to install the other dependencies:
+```bash
 # Install the Poetry dependency management tool, skip if installed
 # Reference: https://python-poetry.org/docs/#installation
 curl -sSL https://install.python-poetry.org | python3 -
 
 # Install the project dependencies
 poetry install
 ```
-You can also use pip to install the dependencies
 
+You can also use pip to install them:
 ```bash
 pip install -r requirements.txt
 ```
 
+------
+Mac users can install dependencies via `run.sh`:
+```bash
+sh ./run.sh
+```
+
 ## Preparation of other Pre-models
 RVC requires other pre-models to infer and train.
 
@@ -90,7 +102,7 @@ Then use this command to start Webui:
 ```bash
 python infer-web.py
 ```
-If you are using Windows, you can download and extract `RVC-beta.7z` to use RVC directly and use `go-web.bat` to start Webui.
+If you are using Windows or macOS, you can download and extract `RVC-beta.7z` to use RVC directly by using `go-web.bat` on windows or `sh ./run.sh` on macOS to start Webui.
 
 There's also a tutorial on RVC in Chinese and you can check it out if needed.
 
@@ -102,8 +114,10 @@ There's also a tutorial on RVC in Chinese and you can check it out if needed.
 + [FFmpeg](https://github.com/FFmpeg/FFmpeg)
 + [Ultimate Vocal Remover](https://github.com/Anjok07/ultimatevocalremovergui)
 + [audio-slicer](https://github.com/openvpi/audio-slicer)
++ [Vocal pitch extraction:RMVPE](https://github.com/Dream-High/RMVPE)
+  + The pretrained model is trained and tested by [yxlllc](https://github.com/yxlllc/RMVPE) and [RVC-Boss](https://github.com/RVC-Boss).
+  
 ## Thanks to all contributors for their efforts
-
 <a href="https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI/graphs/contributors" target="_blank">
   <img src="https://contrib.rocks/image?repo=RVC-Project/Retrieval-based-Voice-Conversion-WebUI" />
 </a>