Skip to content

Commit

Permalink
doc: optimize instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
fumiama committed Apr 17, 2024
1 parent e700c95 commit 1c5b6b0
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,53 @@
# RVC-Models-Downloader
Quickly download RVC models in 🤗 Hugging Face.

## Quick Start
### Preparation
Put this program into the root directory of RVC.
### Download All Assets
```bash
rvcmd assets/all
```
### Download Latest General Pack (Windows Only)
```bash
rvcmd packs/general/latest
```
### Download ffmpeg Tools (Windows Only)
```bash
rvcmd tools/ffmpeg
```

## Full Usage
```bash
Usage: rvcmd [-notrs] [-dns dns.yaml] 'target/to/download'
-dns string
custom dns.yaml
-notrs
use standard TLS client
'target/to/download'
like packs/general/latest
All available targets:
assets:
all hubert rmvpe uvr5 v1 v2
packs:
amd:
latest
v2:
20230813 20231006
general:
latest
v1:
20230331 20230416 20230428 20230508 20230513 20230516 20230717
v2:
20230528 20230618
intel:
latest
v2:
20230813 20231006
nvidia:
latest
v2:
20230813 20231006
tools:
ffmpeg
```
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func main() {
flag.Parse()
args := flag.Args()
if len(args) != 1 {
fmt.Println("Usage:", os.Args[0], "[-notrs] 'target/to/download'")
fmt.Println("Usage:", os.Args[0], "[-notrs] [-dns dns.yaml] 'target/to/download'")
flag.PrintDefaults()
fmt.Println(" 'target/to/download'\n like packs/general/latest")
fmt.Println("All available targets:")
Expand Down

0 comments on commit 1c5b6b0

Please sign in to comment.