Restructure the repository since simlinking didn't work. Added license and README.

2025-12-07 02:52:47 -05:00
parent c25c717971
commit 3501d73871
5 changed files with 89 additions and 0 deletions
--- a/English/namefix.txt
+++ b/English/namefix.txt
--- a/English/wordfix.txt
+++ b/English/wordfix.txt
--- a/9
+++ b/9
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<html><head>
+<title>301 Moved Permanently</title>
+</head><body>
+<h1>Moved Permanently</h1>
+<p>The document has moved <a href="https://www.wtfpl.net/txt/copying/">here</a>.</p>
+<hr>
+<address>Apache/2.4.65 (Debian) Server at www.wtfpl.net Port 80</address>
+</body></html>
--- a/README.md
+++ 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.
--- a/install.sh
+++ 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