From 3501d738716fa447b0811886bedf1a5d8eaa6899 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Sun, 7 Dec 2025 02:52:47 -0500 Subject: [PATCH] Restructure the repository since simlinking didn't work. Added license and README. --- namefix.txt => English/namefix.txt | 0 wordfix.txt => English/wordfix.txt | 0 LICENSE | 9 ++++++ README.md | 45 ++++++++++++++++++++++++++++++ install.sh | 35 +++++++++++++++++++++++ 5 files changed, 89 insertions(+) rename namefix.txt => English/namefix.txt (100%) rename wordfix.txt => English/wordfix.txt (100%) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 install.sh diff --git a/namefix.txt b/English/namefix.txt similarity index 100% rename from namefix.txt rename to English/namefix.txt diff --git a/wordfix.txt b/English/wordfix.txt similarity index 100% rename from wordfix.txt rename to English/wordfix.txt diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cfde9a8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ + + +301 Moved Permanently + +

Moved Permanently

+

The document has moved here.

+
+
Apache/2.4.65 (Debian) Server at www.wtfpl.net Port 80
+ diff --git a/README.md b/README.md new file mode 100644 index 0000000..c1d3363 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# RHVoice English Pronunciation Fixes + +This repository contains pronunciation dictionaries for RHVoice's English voices. These dictionaries help correct pronunciation of specific words and names that may not be pronounced correctly by default. + +## Contents + +- `English/namefix.txt` - Pronunciation corrections for proper names +- `English/wordfix.txt` - Pronunciation corrections for common words + +## Installation + +### Automatic Installation + +Run the installation script: + +```bash +sudo ./install.sh +``` + +### Manual Installation + +Copy the English directory to the RHVoice dictionaries location: + +```bash +sudo cp -r English /etc/RHVoice/dicts/ +``` + +## Usage + +After installation, RHVoice will automatically use these pronunciation fixes when reading text. You may need to restart any applications using RHVoice for the changes to take effect, e.g. speech-dispatcher. + +## Contributing + +To add new pronunciation fixes: + +1. Edit the appropriate file in the `English/` directory + - `namefix.txt` for proper names + - `wordfix.txt` for common words +2. Follow the format: `word=pronunciation` +3. Test with RHVoice +4. Submit a pull request + +## License + +This project is licensed under the WTFPL (Do What The F*** You Want To Public License). See the [LICENSE](LICENSE) file for details. diff --git a/install.sh b/install.sh new file mode 100644 index 0000000..c22bbf7 --- /dev/null +++ b/install.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash + +# Install RHVoice English pronunciation fixes + +set -e + +# Check if running as root +if [[ $EUID -ne 0 ]]; then + echo "Error: This script must be run as root (use sudo)" >&2 + exit 1 +fi + +# Define paths +dictDir="/etc/RHVoice/dicts" +sourceDir="English" + +# Verify source directory exists +if [[ ! -d "$sourceDir" ]]; then + echo "Error: Source directory '$sourceDir' not found" >&2 + exit 1 +fi + +# Create dictionary directory if it doesn't exist +mkdir -p "$dictDir" + +# Copy English pronunciation fixes +echo "Installing English pronunciation fixes to $dictDir..." +cp -rv "$sourceDir" "$dictDir/" + +echo "Installation complete!" +echo "You may need to restart applications using RHVoice for changes to take effect." +echo "For example:" +echo "sudo killall speech-dispatcher" + +exit 0