Welcome to ReadAlong-Studio’s documentation

Warning

Historical documentation. This site holds documentation for the ReadAlong-Studio (CLI) up to v1.0.20230228. For the latest documentation, please visit https://readalongs.github.io/Studio/.

Audiobook alignment for Indigenous languages

This site provides the full user documentation for ReadAlongs-Studio.

Contents:

• Getting Started
  • Background
  • Required knowledge
  • What you need to make a ReadAlong
• Installation
• Command line interface (CLI) user guide
  • Getting from TXT to XML with readalongs make-xml
  • Aligning your text and audio with readalongs align
  • Supported languages
  • Adding titles, images and do-not-align segments via the config.json file
  • The g2p cascade
  • Breaking up the pipeline
  • Anchors: marking known alignment points
  • Silences: inserting pause-like silences
• Command line interface (CLI) reference
  • readalongs align
  • readalongs make-xml
  • readalongs tokenize
  • readalongs g2p
  • readalongs langs
• Output Realizations
  • Elan/Praat files
  • Web Component
• Advanced topics
  • Adding a new language to g2p
  • Pre-processing your data
• Troubleshooting
  • Phones missing in the acoustic model
  • Type 2
  • Type 3

Indices and tables

• Index

• Module Index

• Search Page