Update README.md

README.md

@@ -1,3 +1,58 @@
----
-license: cc-by-nc-sa-4.0
----
+---
+license: cc-by-nc-sa-4.0
+---
+# Description
+
+The JSONL file generated by the script below contains detailed information about a corpus of public domain films, including their subtitles in multiple languages. Here is a detailed description of its structure:
+
+## JSONL file structure
+
+1. **IMDB**: Unique identifier for the movie in the IMDb database.
+2. **primary_title**: Primary title of the movie.
+3. **original_title**:  Original title of the movie.
+4. **french**: 
+    - **filepath**: Relative path to the French subtitles file.
+    - **subtitles**: List of texts corresponding to the french subtitles, cleaned and formatted.
+5. **english** (optionnel):
+    - **filepath**: Relative path to the English subtitles file.
+    - **subtitles**: List of texts corresponding to the english subtitles, cleaned and formatted.
+6. **spanish** (optionnel):
+    - **filepath** (optionnel): Relative path to the Spanish subtitles file.
+    - **subtitles**: List of texts corresponding to the spanish subtitles, cleaned and formatted.
+7. **italian** (optionnel):
+    - **filepath**: Relative path to the italian subtitles file.
+    - **subtitles**: List of texts corresponding to the italian subtitles, cleaned and formatted.
+8. **german** (optionnel):
+    - **filepath**: Relative path to the German subtitles file.
+    - **subtitles**: List of texts corresponding to the german subtitles, cleaned and formatted.
+
+## JSON Content Examples
+
+Each row of the JSONL file represents a movie and its subtitles in different languages, if available. Here is an example of what a row might look like:
+
+```json
+{
+    "IMDB": "tt1234567",
+    "primary_title": "Example Movie",
+    "original_title": "Example Movie Original",
+    "french": {
+        "filepath": "/tt1234567/french/example_movie.srt",
+        "subtitles": ['Sous-titre', 'en français', 'nettoyé.']
+    },
+    "english": {
+        "filepath": "/tt1234567/english/example_movie.srt",
+        "subtitles": ['Cleaned', 'English', 'subtitle.']
+    },
+    "spanish": {
+        "filepath": "/tt1234567/spanish/example_movie.srt",
+        "subtitles":  ['Subtítulo', 'en español', 'limpiado.']
+    },
+    "italian": {
+        "filepath": "/tt1234567/italian/example_movie.srt",
+        "subtitles": ['Sottotitolo', 'in italiano', 'pulito.']
+    },
+    "german": {
+        "filepath": "/tt1234567/german/example_movie.srt",
+        "subtitles": ['Bereinigte', 'deutsche', 'Untertitel']
+    }
+}