Skip to content

Commit 5055043

Browse files
committed
READMEを最新の状態に更新
1 parent f2d4ac8 commit 5055043

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,39 @@
11
# しゃべしゃべ
2+
23
これはシャドーイングをするためのウェブアプリで、任意の文章を読み上げることができます。これは、
3-
Web Speech APIを使ったネイティブ環境での読み上げを使用し、高速にかつプライバシー配慮して動作が可能です。
4+
ウェブ音声 APIを使ったネイティブ環境での読み上げを使用し、高速にかつプライバシー配慮して動作が可能です。
45

56
- **HTMLのペーストに対応** — HTMLをペーストした時、スタイルを消して書式そのままにペーストが可能。
67
- **部分的な読み上げ** — 文章を選択した時、その選択した部分だけ読み上げ可能。
78
- **シンプルなUI** — ブラウザ標準のデザインを踏襲し、基本配色も二色で明瞭。
89
- **ダークモード対応** — システムに合わせる自動機能付き。
910

1011
## 技術スタック
12+
1113
- Bun
1214
- SolidJS
1315
- Tailwind CSS
1416
[Preflight](https://tailwindcss.com/docs/preflight)が無効化されています。
1517
開発時にはこれを留意してください。
16-
- Tailwind Variants
17-
- Cloudflare Pages
18+
- GitHub Pages
1819

1920
## 開発
21+
2022
### 用語
23+
2124
- Voice: ウェブ音声 APIの`SpeechSynthesisVoice`のことで、音声の種類を表す。
2225
- Paper: シャドーイング対象の文章を配置する場所、文章を操作したりするためのクラスが存在する。
2326
- TTS: 読み上げをするためのクラスのこと。
27+
- MainController: 画面上部にある操作パネルのこと。
28+
- QuickController: 大きい画面の場合でかつ、文章選択時にポップアップ形式で表示される小さい操作パネルのこと。
2429

2530
### 起動方法
31+
2632
1. Bunが必要なのでまずBunをインストール
2733
2. `bun i`で依存関係をインストール
2834
3. `bun dev`で起動
2935

3036
## その他情報
37+
3138
- [ライセンス](./LICENSE)
3239
- [ウェブサイト](https://shabe2x.tasuren.jp)

0 commit comments

Comments
 (0)