Skip to content

Commit

Permalink
docs(readme): shorten docs (#75)
Browse files Browse the repository at this point in the history
  • Loading branch information
34j authored Mar 22, 2023
1 parent 2b34290 commit e0c1572
Showing 1 changed file with 12 additions and 33 deletions.
45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,21 @@

A fork of [`so-vits-svc`](https://github.com/svc-develop-team/so-vits-svc) with **realtime support** and **greatly improved interface**. Based on branch `4.0` (v1) and the models are compatible.

## Installation

### (Create a virtual environment)

Windows:

```shell
py -3.10 -m venv venv
venv\Scripts\activate
```

Linux/MacOS:
## Features not available in the original repo

```shell
python3.10 -m venv venv
source venv/bin/activate
```
- **Realtime voice conversion** (enhanced in v1.1.0)
- More accurate pitch estimation using CREPE
- GUI available
- Unified command-line interface (no need to run Python scripts)
- Ready to use just by installing with `pip`.
- Automatically download pretrained base model and HuBERT model
- Code completely formatted with black, isort, autoflake etc.
- Volume normalization in preprocessing
- Other minor differences

Anaconda:
## Installation

```shell
conda create -n so-vits-svc-fork python=3.10 pip
conda activate so-vits-svc-fork
```
### [Creating a Virtual Environment](https://github.com/34j/so-vits-svc-fork/wiki#creating-a-virtual-environment)

### Install

Expand All @@ -74,18 +65,6 @@ Please update this package regularly to get the latest features and bug fixes.
pip install -U so-vits-svc-fork
```

## Features not available in the original repo

- **Realtime voice conversion** (enhanced in v1.1.0)
- More accurate pitch estimation using CREPE
- GUI available
- Unified command-line interface (no need to run Python scripts)
- Ready to use just by installing with `pip`.
- Automatically download pretrained base model and HuBERT model
- Code completely formatted with black, isort, autoflake etc.
- Volume normalization in preprocessing
- Other minor differences

## Usage

### Inference
Expand Down

0 comments on commit e0c1572

Please sign in to comment.