From 1c5b6b008c635da2e40bbf6d461c86ed9382cb90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=BA=90=E6=96=87=E9=9B=A8?= <41315874+fumiama@users.noreply.github.com> Date: Thu, 18 Apr 2024 02:13:23 +0900 Subject: [PATCH] doc: optimize instructions --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ main.go | 2 +- 2 files changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97433b8..e21308e 100644 --- a/README.md +++ b/README.md @@ -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 +``` diff --git a/main.go b/main.go index 10e9d5c..2449dcf 100644 --- a/main.go +++ b/main.go @@ -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:")