From b4ce566c76f86889ee93083efc17f71a2a817f96 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Mon, 22 Jun 2026 02:34:04 +0800
Subject: feat: embed Windows icon and add build resources
---
README.md | 38 ++++++++++++++++++++++++++++++++------
1 file changed, 32 insertions(+), 6 deletions(-)
(limited to 'README.md')
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
+
+
+
+ Dumb Voice Protocol
+
-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
--
cgit