Merge pull request #58 from senju1337/docs/OPS-92

docs: add mention of TTS
This commit is contained in:
Christoph J. Scherr 2025-03-27 17:13:11 +01:00 committed by GitHub
commit 994ad694ec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -42,6 +42,7 @@ Senju (千手, "thousand hands") is a web service for haiku poetry generation an
- **🔍 Browse Existing Haiku**: Gallery view of previously generated poetry - **🔍 Browse Existing Haiku**: Gallery view of previously generated poetry
- **💾 Persistent Storage**: All generated haiku are stored for future retrieval - **💾 Persistent Storage**: All generated haiku are stored for future retrieval
- **🖥️ Web Interface**: Clean, efficient, minimalist user experience for human interaction - **🖥️ Web Interface**: Clean, efficient, minimalist user experience for human interaction
- **👂 Accessibility**: Text-to-speech integration for haikus
## 🔧 Installation ## 🔧 Installation
@ -67,6 +68,16 @@ Docker desktop users on windows might need to change the line seperator from CRL
See `pyproject.toml` for a complete list of dependencies. See `pyproject.toml` for a complete list of dependencies.
#### Text To Speech
The speech synthesis uses the functionalities of your Operating System. Depending on your System, you might need to install additional software to use speech synthesis. On Debian GNU/Linux, you need to do the following:
```bash
apt install espeakup speech-dispatcher
```
Senju uses [`window.speechSynthesis`](https://developer.mozilla.org/en-US/docs/Web/API/Window/speechSynthesis) for TTS.
## 🏯 Architecture ## 🏯 Architecture
Senju is built around several key components: Senju is built around several key components: