Skip to content

Commit 71a4e18

Browse files
authored
docs: document phonemis submodule init for demo apps (#1193)
## Description The TTS pipeline depends on the `phonemis` git submodule under `packages/react-native-executorch/third-party/common`, which isn't pulled by a plain `git clone`. The demo-app instructions in the root README and all translated READMEs (`readmes/README_{cn,es,fr,in,pt}.md`) skipped this step, so running any TTS-touching demo fails out of the box. This PR adds the scoped `git submodule update --init packages/react-native-executorch/third-party/common` step to each README. Scoped to `.../common` instead of `--recursive` so we don't pull `tokenizers-cpp` and `googletest`, which the demo apps don't need. ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [x] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions 1. Fresh-clone the repo without `--recurse-submodules`. 2. Follow the updated Demo Apps section. 3. Confirm the speech app builds and runs end-to-end. ### Screenshots ### Related issues ### Checklist - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [x] My changes generate no new warnings ### Additional notes
1 parent 72e2d55 commit 71a4e18

6 files changed

Lines changed: 42 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,13 @@ We currently host a few example [apps](https://github.com/software-mansion/react
146146
- `text-embeddings` - Computing text representations for semantic search
147147
- `bare-rn` - LLM chat example for bare React Native (without Expo)
148148

149-
If you would like to run a demo app, navigate to its project directory. Then install dependencies and run app with:
149+
If you would like to run a demo app, first initialize the required git submodules from the repository root:
150+
151+
```bash
152+
git submodule update --init packages/react-native-executorch/third-party/common
153+
```
154+
155+
Then navigate to its project directory, install dependencies and run app with:
150156

151157
```bash
152158
yarn && yarn <ios|android>

readmes/README_cn.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,13 @@ const handleGenerate = async () => {
142142
- `text-embeddings` - 用于语义搜索的文本表示计算
143143
- `bare-rn` - 适用于原生 React Native(无 Expo)的 LLM 聊天示例
144144

145-
如果您想运行示例应用程序,请导航到其项目目录。然后安装依赖项并运行应用:
145+
如果您想运行示例应用程序,请先在代码库根目录初始化所需的 git 子模块:
146+
147+
```bash
148+
git submodule update --init packages/react-native-executorch/third-party/common
149+
```
150+
151+
然后导航到其项目目录,安装依赖项并运行应用:
146152

147153
```bash
148154
yarn && yarn <ios|android>

readmes/README_es.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,13 @@ Actualmente alojamos algunos ejemplos de [aplicaciones](https://github.com/softw
142142
- `text-embeddings` - Cálculo de representaciones de texto para búsqueda semántica
143143
- `bare-rn` - Ejemplo de chat LLM para React Native puro (sin Expo)
144144

145-
Si deseas ejecutar una aplicación de demostración, navega a su directorio de proyecto. Luego instala las dependencias y ejecuta la app con:
145+
Si deseas ejecutar una aplicación de demostración, primero inicializa los submódulos de git necesarios desde la raíz del repositorio:
146+
147+
```bash
148+
git submodule update --init packages/react-native-executorch/third-party/common
149+
```
150+
151+
Luego navega a su directorio de proyecto, instala las dependencias y ejecuta la app con:
146152

147153
```bash
148154
yarn && yarn <ios|android>

readmes/README_fr.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,13 @@ Nous hébergeons actuellement quelques applications [exemples](https://github.co
142142
- `text-embeddings` - Calcul de représentations textuelles pour la recherche sémantique
143143
- `bare-rn` - Exemple de chat LLM pour React Native sans Expo
144144

145-
Si vous souhaitez exécuter une application de démonstration, accédez à son répertoire de projet. Puis installez les dépendances et lancez l'application avec :
145+
Si vous souhaitez exécuter une application de démonstration, initialisez d'abord les sous-modules git nécessaires depuis la racine du dépôt :
146+
147+
```bash
148+
git submodule update --init packages/react-native-executorch/third-party/common
149+
```
150+
151+
Puis accédez à son répertoire de projet, installez les dépendances et lancez l'application avec :
146152

147153
```bash
148154
yarn && yarn <ios|android>

readmes/README_in.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,13 @@ const handleGenerate = async () => {
142142
- `text-embeddings` - अर्थ सेमांटिक खोज के लिए पाठ प्रस्तुतिकरण की गणना
143143
- `bare-rn` - bare React Native (Expo के बिना) के लिए LLM चैट उदाहरण
144144

145-
यदि आप डेमो ऐप चलाना चाहते हैं, तो इसके प्रोजेक्ट डायरेक्टरी में नेविगेट करें। फिर निर्भरता इंस्टॉल करें और ऐप चलाएं:
145+
यदि आप डेमो ऐप चलाना चाहते हैं, तो पहले रिपॉजिटरी रूट से आवश्यक git submodules आरंभ करें:
146+
147+
```bash
148+
git submodule update --init packages/react-native-executorch/third-party/common
149+
```
150+
151+
फिर इसके प्रोजेक्ट डायरेक्टरी में नेविगेट करें, निर्भरता इंस्टॉल करें और ऐप चलाएं:
146152

147153
```bash
148154
yarn && yarn <ios|android>

readmes/README_pt.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,13 @@ Atualmente, hospedamos alguns [apps](https://github.com/software-mansion/react-n
142142
- `text-embeddings` - Computação de representações de texto para busca semântica
143143
- `bare-rn` - Exemplo de chat LLM para React Native puro (sem Expo)
144144

145-
Se deseja executar um aplicativo de demonstração, navegue até seu diretório de projeto. Em seguida, instale as dependências e execute o aplicativo com:
145+
Se deseja executar um aplicativo de demonstração, primeiro inicialize os submódulos do git necessários a partir da raiz do repositório:
146+
147+
```bash
148+
git submodule update --init packages/react-native-executorch/third-party/common
149+
```
150+
151+
Em seguida, navegue até seu diretório de projeto, instale as dependências e execute o aplicativo com:
146152

147153
```bash
148154
yarn && yarn <ios|android>

0 commit comments

Comments
 (0)