Add English to Katakana and Romaji conversion support
This commit is contained in:
34
README.md
34
README.md
@ -15,22 +15,46 @@ Voice RSS Summary automatically collects RSS feeds, summarizes new articles usin
|
||||
- [Bun](https://bun.sh/) 1.x (if running locally)
|
||||
- VOICEVOX engine
|
||||
- An OpenAI API key
|
||||
- MeCab (for English to Katakana conversion)
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install dependencies:
|
||||
1. Install MeCab (for English to Katakana conversion):
|
||||
|
||||
**macOS (using Homebrew):**
|
||||
```bash
|
||||
brew install mecab mecab-ipadic
|
||||
```
|
||||
|
||||
**Ubuntu/Debian:**
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install mecab mecab-ipadic-utf8 libmecab-dev
|
||||
```
|
||||
|
||||
**CentOS/RHEL/Fedora:**
|
||||
```bash
|
||||
sudo yum install mecab mecab-ipadic mecab-devel
|
||||
# or for newer versions:
|
||||
sudo dnf install mecab mecab-ipadic mecab-devel
|
||||
```
|
||||
|
||||
**Manual installation:**
|
||||
See the setup script: `scripts/setup-mecab.sh`
|
||||
|
||||
2. Install dependencies:
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
2. Build the front end:
|
||||
3. Build the front end:
|
||||
|
||||
```bash
|
||||
bun run build:frontend
|
||||
```
|
||||
|
||||
3. Create a `.env` file and set the following variables:
|
||||
4. Create a `.env` file and set the following variables:
|
||||
|
||||
```env
|
||||
OPENAI_API_KEY=your-api-key
|
||||
@ -49,9 +73,9 @@ Voice RSS Summary automatically collects RSS feeds, summarizes new articles usin
|
||||
FEED_URLS_FILE=feed_urls.txt
|
||||
```
|
||||
|
||||
4. Prepare `feed_urls.txt` with one RSS feed URL per line.
|
||||
5. Prepare `feed_urls.txt` with one RSS feed URL per line.
|
||||
|
||||
5. Start the server:
|
||||
6. Start the server:
|
||||
|
||||
```bash
|
||||
bun run server.ts
|
||||
|
Reference in New Issue
Block a user