Skip to content

Releases: RonanDavalan/PiperRead

PiperRead v0.1.1-Alpha

13 Jan 21:50

Choose a tag to compare

Audio Quality & Speech Optimization

This release focuses on improving the listening experience by introducing a text-processing layer. It addresses issues where Markdown syntax and non-vocal elements (like images or links) were interfering with the speech synthesis engine.

New Features

  • Markdown Sanitization: Added a dedicated module to strip formatting characters (**, __, #, etc.) before they reach the TTS engine.
  • Modular Architecture: Implementation of utils/cleaner.sh to handle text transformation, keeping the main orchestrator clean.
  • Improved Flow: The speech synthesis now processes "clean" plain text, resulting in a more natural prosody.

Bug Fixes

  • Audio Artifacts: Fixed "breathing" or "hissing" noises caused by the engine attempting to vocalize image tags (![alt](url)) and complex URLs.
  • Syntax Reading: Prevented Piper from reading aloud formatting symbols (e.g., no longer saying "star star bold star star").

Technical Changes

  • New utility script: utils/cleaner.sh.
  • Updated read.sh to include the sanitization hook.
  • Security: Enforced 700 permissions on new utility scripts (following security best practices).

How to update

To update your local installation to v0.1.1-Alpha:

git pull origin main
# Ensure permissions are correct
chmod 700 read.sh utils/cleaner.sh

PiperRead v0.1-Alpha

11 Jan 21:45

Choose a tag to compare

🎉 Initial Release

PiperRead is a minimalist, privacy-focused tool to read aloud any selected text on Linux using the high-quality Piper neural engine.

🚀 Features in v0.1-Alpha

  • Universal: Auto-detection for Wayland (wl-clipboard) and X11 (xsel).
  • Privacy First: 100% local processing (No cloud data).
  • Smart: Reads mouse selection (primary) or clipboard content.
  • Clean: Runs in an isolated Python Virtual Environment (piper-env).
  • Desktop Ready: Includes .desktop file for menu integration.

🛠️ Installation

Clone the repository and run the setup steps documented in the README.

git clone https://github.com/RonanDavalan/PiperRead.git

Built with Vibe Coding by Ronan Davalan, Google Gemini, Claude & Perplexity.