From 4f1323b3d12a080f38a195bf494db7086dbfa7e4 Mon Sep 17 00:00:00 2001
From: 34j <55338215+34j@users.noreply.github.com>
Date: Wed, 22 Mar 2023 20:40:39 +0900
Subject: [PATCH] docs(readme): update README.md regarding installation,
 update. WSL audio support (#72)

Co-authored-by: GarrettConway <gconway@g.hmc.edu>
---
 README.md | 38 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b620d51a..5784a545 100644
--- a/README.md
+++ b/README.md
@@ -34,11 +34,44 @@ A fork of [`so-vits-svc`](https://github.com/svc-develop-team/so-vits-svc) with
 
 ## Installation
 
-Install this via pip (or your favourite package manager):
+### (Create a virtual environment)
+
+Windows:
+
+```shell
+py -3.10 -m venv venv
+venv\Scripts\activate
+```
+
+Linux/MacOS:
+
+```shell
+python3.10 -m venv venv
+source venv/bin/activate
+```
+
+Anaconda:
+
+```shell
+conda create -n so-vits-svc-fork python=3.10 pip
+conda activate so-vits-svc-fork
+```
+
+### Install
+
+Install this via pip (or your favourite package manager that uses pip):
 
 ```shell
 pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu117
-pip install so-vits-svc-fork
+pip install -U so-vits-svc-fork
+```
+
+### Update
+
+Please update this package regularly to get the latest features and bug fixes.
+
+```shell
+pip install -U so-vits-svc-fork
 ```
 
 ## Features not available in the original repo
@@ -85,6 +118,7 @@ svc --model-path <model-path> source.wav
 
 #### Notes
 
+- If using WSL, please note that WSL requires additional setup to handle audio and the GUI will not work without finding an audio device.
 - In real-time inference, if there is noise on the inputs, the HuBERT model will react to those as well. Consider using realtime noise reduction applications such as [RTX Voice](https://www.nvidia.com/en-us/geforce/guides/nvidia-rtx-voice-setup-guide/) in this case.
 
 ### Training