add readme

This commit is contained in:
jrosh 2025-06-02 15:18:59 +02:00
commit d4d02bd2d9
No known key found for this signature in database
GPG key ID: A4D68DCA6C9CCD2D
3 changed files with 56 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 jroshthen1
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

35
README.md Normal file
View file

@ -0,0 +1,35 @@
# Simple TTS UI
My tts ui program for unix
I made this program as an alternative to my bash script for text chunking and sequential streaming
Screenshot:
![screenshot](./screenshot.png "Screenshot")
## Installation
Dependencies: hexgrad/Kokoro or lucasjinreal/Kokoros and a player aplay/paplay/play/ffplay/mpg123
Build dependencies: eframe, egui, atty, tempfile
Set path for TTS: (these settings can be changed after build)
```rust
impl Default for KokoroConfig {
fn default() -> Self {
let home = std::env::var("HOME").unwrap_or_else(|_| ".".to_string());
Self {
exec_path: format!("{}/kokoros/target/release/koko", home),
model_path: format!("{}/kokoros/checkpoints/kokoro-v1.0.onnx", home),
voice_data: format!("{}/kokoros/voices-v1.0.bin", home),
speed: 1.1,
voice_style: "af_heart".to_string(),
chunking: ChunkingConfig::default(),
}
}
}
```
Build this app with `cargo build --release`
Then run `echo "Hello, world" | ./target/release/ttsui`

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB