new: add documentation for subtitle format, phonetics, and translation structure

2026-07-06 17:01:01 +02:00
parent 743697202e
commit f8b82bcd99
2 changed files with 79 additions and 24 deletions
@@ -0,0 +1,37 @@
+# Subtitles
+
+## Format
+
+The LRC lyrics format is used for subtitles with no end time.
+
+## Tools
+
+We recommend using Subtitle Edit open source software for editing subtitles.
+
+Source code: https://github.com/SubtitleEdit/subtitleedit
+
+## Phonetics
+
+To highlight muted characters, use curly brackets `{}` around the character that is muted
+phonetically.
+
+To highlight linking characters, use square brackets `[]` around the character that is linked
+phonetically. Don't add space before or after the square brackets.
+
+## File naming & translation
+
+The main file is the transcription file and follow the file name pattern:
+`<description>_st_bzh.lrc`.
+
+The translation file should follow the file name pattern: `<description>_st_fr.lrc` and have the
+same timestamps as the matching transcription.
+
+The `<description>` part of the name should also be the same as the one in the transcription file.
+
+## Package structure
+
+The transcription and translation files should be in the same directory, under the `:data:ressources`
+module, in `comminMain/composeResources/files`. They are exposed as Compose resources.
+
+For more, see: https://kotlinlang.org/docs/multiplatform/compose-multiplatform-resources.html
+