From 64e6127398cdd40e10dc2bd419d101068b980a35 Mon Sep 17 00:00:00 2001 From: "Christoph J. Scherr" Date: Thu, 27 Mar 2025 17:11:58 +0100 Subject: [PATCH] docs: add mention of TTS Refs: OPS-92 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 8362b2e..014997c 100644 --- a/README.md +++ b/README.md @@ -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 - **💾 Persistent Storage**: All generated haiku are stored for future retrieval - **🖥️ Web Interface**: Clean, efficient, minimalist user experience for human interaction +- **👂 Accessibility**: Text-to-speech integration for haikus ## 🔧 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. +#### 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 Senju is built around several key components: