aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-06-22 02:34:04 +0800
committer魏曹先生 <1992414357@qq.com>2026-06-22 02:34:04 +0800
commitb4ce566c76f86889ee93083efc17f71a2a817f96 (patch)
tree99d03f034263f08a184ae6af930ede07fb98fdad /README.md
parentf3e63efe8bec62e077b27c36a716a42d41728a25 (diff)
feat: embed Windows icon and add build resources0.1.0-release
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 32 insertions, 6 deletions
diff --git a/README.md b/README.md
index 394622d..fb35cd6 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,41 @@
-## Dumb Voice Protocol
+<div align="center">
+<img src="https://github.com/catilgrass/dumb-voice-protocol/blob/master/icon/icon.ico" width="30%" />
+</div>
-# Intro
+<h1 align="center">
+ Dumb Voice Protocol
+</h1>
-This is a CLI program that reads your microphone device and outputs information to stdout / ipc.
+## Introduction
-# Usage
+A "dumb" voice input terminal based on [vtx-engine](https://github.com/keathmilligan/vtx-engine) and [Whisper](https://github.com/openai/whisper) — reads from microphone, transcribes to text, sends it to your game or tool.
+
+Supports multiple output methods: stdout / stderr / TCP / UDP / UDP broadcast / IPC, suitable for various scenarios.
+
+## Usage
+
+1. Go to [Releases](https://github.com/catilgrass/dumb-voice-protocol/releases) and download the latest version
+2. Unzip, edit `dmvop.toml` to configure
+3. Double-click `dmvop.exe` and start speaking
+
+## Usage (CLI)
+
+1. Go to [Releases](https://github.com/catilgrass/dumb-voice-protocol/releases) and download
+2. Open a terminal, run `dmvop -h` to see options
+3. Speak into the microphone
+
+Common examples:
```
-dmvop --help
+dmvop # Load dmvop.toml from current directory
+dmvop --device="My Mic" -O=stdout # Voice → terminal
+dmvop --device="My Mic" -O=tcp -O=stdout # Voice → game + terminal
+dmvop --device="My Mic" -O=udp-broadcast # Voice → LAN broadcast
+
+dmvop --list-devices # List microphone devices
+dmvop --download-model=small # Download whisper model
```
-# License
+## License
Under WTFPL