70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# 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
|
|
|
|
## Update Scripts
|
|
|
|
### Linux
|
|
|
|
Run the Linux update script:
|
|
|
|
```bash
|
|
sudo ./update_linux.sh
|
|
```
|
|
|
|
This copies the `English` directory to `/etc/RHVoice/dicts/`.
|
|
|
|
### Android
|
|
|
|
Run the Android update script with your device connected over `adb`:
|
|
|
|
```bash
|
|
./update_android.sh
|
|
```
|
|
|
|
The Android script checks for `adb`, verifies that `com.github.olga_yakovleva.rhvoice.android` is installed, creates the RHVoice dictionary directory if needed, and pushes the dictionary files to:
|
|
|
|
```text
|
|
/sdcard/Android/data/com.github.olga_yakovleva.rhvoice.android/files/dicts/English
|
|
```
|
|
|
|
RHVoice also keeps its config under the same external app files directory, for example:
|
|
|
|
```text
|
|
/sdcard/Android/data/com.github.olga_yakovleva.rhvoice.android/files/RHVoice.conf
|
|
```
|
|
|
|
Android private app data also exists under `/data/user/0/com.github.olga_yakovleva.rhvoice.android`, but that area is not readable over normal `adb` on a non-debuggable Play Store build.
|
|
|
|
### Manual Linux 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.
|