Skip to content

Commit b0a3e2f

Browse files
committed
Update readme
1 parent 43a44ab commit b0a3e2f

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ OpenReader WebUI is a document reader with Text-to-Speech capabilities, offering
3030
- 🗣️ Multiple voice options (checks `/v1/audio/voices` endpoint)
3131
- 🎨 Multiple app theme options
3232

33-
> Orpheus-FastAPI will only work through a [fork of Orpheus-FastAPI](https://github.com/richardr1126/LlamaCpp-Orpheus-FastAPI)
34-
3533
### 🛠️ Work in progress
3634
- [x] **Audiobook creation and download** (m4b format)
3735
- [x] **Support for GPT-4o Mini TTS with instructions**
@@ -80,7 +78,6 @@ docker pull ghcr.io/richardr1126/openreader-webui:latest
8078

8179
> Note: This is an example of how to add OpenReader WebUI to a docker-compose file. You can add it to your existing docker-compose file or create a new one in this directory. Then run `docker-compose up --build` to start the services.
8280
83-
```bash
8481

8582
Create or add to a `docker-compose.yml`:
8683
```yaml
@@ -106,9 +103,11 @@ services:
106103
- Node.js & npm (recommended: use [nvm](https://github.com/nvm-sh/nvm))
107104
Optionally required for different features:
108105
- [FFmpeg](https://ffmpeg.org) (required for audiobook m4b creation only)
106+
- On Linux: `sudo apt install ffmpeg`
107+
- On MacOS: `brew install ffmpeg`
109108
- [libreoffice](https://www.libreoffice.org) (required for DOCX files)
110-
- On Linux: `sudo apt install ffmpeg libreoffice`
111-
- On MacOS: `brew install ffmpeg libreoffice`
109+
- On Linux: `sudo apt install libreoffice`
110+
- On MacOS: `brew install libreoffice`
112111

113112
### Steps
114113

@@ -158,14 +157,18 @@ Contributions are welcome! Fork the repository and submit a pull request with yo
158157

159158
## ❤️ Acknowledgements
160159

161-
- [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) for the API wrapper
162-
- [react-pdf](https://github.com/wojtekmaj/react-pdf)
163-
- [react-reader](https://github.com/happyr/react-reader)
164-
- [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) for text-to-speech
160+
This project would not be possible without standing on the shoulders of these giants:
161+
162+
- [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) model
163+
- [Orpheus-TTS](https://huggingface.co/collections/canopylabs/orpheus-tts-67d9ea3f6c05a941c06ad9d2) model
164+
- [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI)
165+
- [Orpheus-FastAPI](https://github.com/Lex-au/Orpheus-FastAPI)
166+
- [react-pdf](https://github.com/wojtekmaj/react-pdf) npm package
167+
- [react-reader](https://github.com/happyr/react-reader) npm package
165168

166169
## Docker Supported Architectures
167170
- linux/amd64 (x86_64)
168-
- linux/arm64 (Apple Silicon)
171+
- linux/arm64 (Apple Silicon, Raspberry Pi, SBCs, etc.)
169172

170173
## Stack
171174

@@ -182,8 +185,9 @@ Contributions are welcome! Fork the repository and submit a pull request with yo
182185
- [Tailwind CSS](https://tailwindcss.com)
183186
- [Headless UI](https://headlessui.com)
184187
- **TTS:** (tested on)
185-
- [OpenAI API](https://platform.openai.com/docs/api-reference/text-to-speech)
186188
- [Kokoro FastAPI TTS](https://github.com/remsky/Kokoro-FastAPI/tree/v0.0.5post1-stable)
189+
- [Orpheus FastAPI TTS](https://github.com/Lex-au/Orpheus-FastAPI)
190+
- [OpenAI API](https://platform.openai.com/docs/api-reference/text-to-speech)
187191
- **NLP:** [compromise](https://github.com/spencermountain/compromise) NLP library for sentence splitting
188192

189193
## License

0 commit comments

Comments
 (0)