Merge pull request #129 from meganetaaan/fix/docs-link

Add English/Japanese docs link vice versa
stack-chan · Mar 5, 2023 · a9a00ed · a9a00ed
2 parents c5baa56 + bb937f3
commit a9a00ed
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 0 deletions.
diff --git a/firmware/README_ja.md b/firmware/README_ja.md
@@ -1,5 +1,7 @@
 # ｽﾀｯｸﾁｬﾝ ファームウェア
 
+[English](./README.md)
+
 ## 注意
 
 * ファームウェアは現在も積極的に開発中です。内部の作りやAPIが大きく変わる可能性があります。

diff --git a/firmware/docs/api.md b/firmware/docs/api.md
@@ -1,5 +1,7 @@
 # API
 
+[日本語](./api_ja.md)
+
 The detailed API document is under construction.
 
 The source codes of Stack-chan has `TSDoc` style comments.

diff --git a/firmware/docs/api_ja.md b/firmware/docs/api_ja.md
@@ -1,5 +1,7 @@
 # API
 
+[English](./api.md)
+
 APIの詳しいドキュメントは現在作成中です。
 
 ｽﾀｯｸﾁｬﾝのソースコードには `TSDoc` 形式のコメントがついています。

diff --git a/firmware/docs/flashing-firmware.md b/firmware/docs/flashing-firmware.md
@@ -1,5 +1,7 @@
 ## Build and flash firmware
 
+[日本語](./flashing-firmware_ja.md)
+
 ## Firmware architecture
 
 ### Host and MOD

diff --git a/firmware/docs/flashing-firmware_ja.md b/firmware/docs/flashing-firmware_ja.md
@@ -1,5 +1,7 @@
 # プログラムのビルドと書き込み
 
+[English](./flashing-firmware.md)
+
 ## ｽﾀｯｸﾁｬﾝのプログラム構成について
 
 ### ホストと MOD

diff --git a/firmware/docs/getting-started.md b/firmware/docs/getting-started.md
@@ -1,5 +1,7 @@
 # Getting Started
 
+[日本語](./getting-started_ja.md)
+
 ## Prerequisites
 
 * Host PC

diff --git a/firmware/docs/getting-started_ja.md b/firmware/docs/getting-started_ja.md
@@ -1,5 +1,7 @@
 # 環境構築
 
+[English](./getting-started.md)
+
 ## 開発に必要なもの
 
 * ホストPC

diff --git a/firmware/docs/text-to-speech.md b/firmware/docs/text-to-speech.md
@@ -1,5 +1,7 @@
 # Using Text To Speech(TTS)
 
+[日本語](./text-to-speech_ja.md)
+
 Currently there are two way to use TTS.
 
 * __Pregenerated__: Generates and flash speeches at buildtime and plays standalone. Suitable for predefined statements.

diff --git a/firmware/docs/text-to-speech_ja.md b/firmware/docs/text-to-speech_ja.md
@@ -1,5 +1,7 @@
 # TTS（音声合成）の使用
 
+[English](./text-to-speech.md)
+
 現在、TTSを使用するには2つの方法があります。
 
 * __事前生成__：ビルド時に音声を生成し、スタンドアロンで再生します。事前に定義された文章に適しています。