Restructure the repository since simlinking didn't work. Added license and README.
This commit is contained in:
45
README.md
Normal file
45
README.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user