Skip to content

Commit 863eba2

Browse files
Hiroshibaclaude
andauthored
docs: READMEにVVMファイル名の頭文字による種類分けを記載 (#45)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent a557dd4 commit 863eba2

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,4 +547,12 @@ https://voicevox.hiroshiba.jp/nemo/term/
547547
| n0.vvm | 男声2 | ノーマル | 10000 |
548548
| n0.vvm | 男声3 | ノーマル | 10002 |
549549

550+
## 備考
551+
552+
VVM ファイル名の頭文字で種類を分けています。
553+
554+
- 頭文字なし(数字から始まる):トーク用
555+
- `s` から始まる:ソング用
556+
- `n` から始まる:Nemo 用
557+
550558
<!-- vvm-table end -->

docs/MAINTENANCE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- VOICEVOX CORE にとって破壊的変更となる場合はメジャーバージョンを上げる
2121
- 左から 1 つ目の 0 ではない値をメジャーバージョンのように扱う
2222
- 例えば 0.1.0 から更新するとき、破壊的変更があるときは 0.2.0 に、ないときは 0.1.1 にする
23+
- VVM ファイル名の頭文字を変更した場合は破壊的変更として扱う
2324

2425
## VVM 内の情報
2526

scripts/make_docs.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ def generate_vvm_text(vvm_files: list[Path]):
168168
output_text += generate_table("ソング", song_entries)
169169
output_text += "\n"
170170
output_text += generate_table("Nemo トーク", nemo_talk_entries)
171+
output_text += "\n"
172+
output_text += generate_notes()
171173

172174
return output_text
173175

@@ -197,6 +199,16 @@ def generate_table(section_name: str, entries: list[StyleEntry]) -> str:
197199
return table_text
198200

199201

202+
def generate_notes() -> str:
203+
"""備考セクションを生成"""
204+
notes_text = "## 備考\n\n"
205+
notes_text += "VVM ファイル名の頭文字で種類を分けています。\n\n"
206+
notes_text += "- 頭文字なし(数字から始まる):トーク用\n"
207+
notes_text += "- `s` から始まる:ソング用\n"
208+
notes_text += "- `n` から始まる:Nemo 用\n"
209+
return notes_text
210+
211+
200212
def update_readme(readme_path: Path, terms: Terms, vvm_text: str):
201213
"""README.mdの内容を置換"""
202214
readme_text = readme_path.read_text(encoding="utf-8")

0 commit comments

Comments
 (0)