Skip to content

docs: document phonemis submodule init for demo apps - #1193

Merged
msluszniak merged 1 commit into
mainfrom
@ms/readme-submodule-instructions
May 28, 2026
Merged

docs: document phonemis submodule init for demo apps#1193
msluszniak merged 1 commit into
mainfrom
@ms/readme-submodule-instructions

Conversation

@msluszniak

Copy link
Copy Markdown
Member

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
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • 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

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

The TTS pipeline depends on the phonemis git submodule under
packages/react-native-executorch/third-party/common, which is not
initialized by a plain clone. Running the demo apps without it fails,
so document the scoped 'git submodule update --init' step in all
language READMEs.
@msluszniak msluszniak self-assigned this May 27, 2026
@msluszniak msluszniak added documentation Improvements or additions to documentation demo app labels May 27, 2026
@msluszniak
msluszniak requested review from barhanc and chmjkb May 27, 2026 17:40
@msluszniak
msluszniak merged commit 71a4e18 into main May 28, 2026
2 checks passed
@msluszniak
msluszniak deleted the @ms/readme-submodule-instructions branch May 28, 2026 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

demo app documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants