Submodule i18n

.github/workflows/android_ci.yml

@@ -16,6 +16,8 @@ jobs:
         steps:
             - name: Checkout repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -32,6 +34,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -44,6 +48,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Set up JDK
               uses: actions/setup-java@v1
@@ -65,6 +71,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp
@@ -86,6 +94,8 @@ jobs:
         steps:
             - name: Checkout Repository
               uses: actions/checkout@v4
+              with:
+                  submodules: true
 
             - name: Prepare App
               uses: ./.github/composite/prepareApp

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "app/src/main/assets/i18n"]
+	path = app/src/main/assets/i18n
+	url = https://github.com/scribe-org/Scribe-i18n.git

CONTRIBUTING.md

@@ -90,16 +90,19 @@ Scribe-Android is developed using the [Kotlin](https://kotlinlang.org/) coding l
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> -   e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-Android.git`
+> -   e.g. Cloning (with submodules) now becomes `git clone --recurse-submodules git@github.com:<your-username>/Scribe-Android.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
-git clone https://github.com/<your-username>/Scribe-Android.git
+# Clone your fork of the repo into the current directory (including submodules).
+git clone --recurse-submodules https://github.com/<your-username>/Scribe-Android.git
 # Navigate to the newly cloned directory.
 cd Scribe-Android
 # Assign the original repo to a remote called "upstream".
@@ -337,7 +340,7 @@ Scribe does not accept direct edits to the grammar files as they are sourced fro
 
 Being an app that focusses on language learning, localization plays a big part in what Scribe will eventually be. Those interested are more than welcome to join the team at [scribe-org/Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where we work on localizing all Scribe applications via [Weblate](https://weblate.org/).
 
-Please run the [update_i18n_keys.sh](https://github.com/scribe-org/Scribe-Android/blob/main/update_i18n_keys.sh) script to load in the most recent version of the [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) app texts into Scribe-Android.
+Please run the [update_i18n_keys.sh](./update_i18n_keys.sh) script to load in the most recent version of the [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) app texts into Scribe-Android.
 
 ### Progress
 

README.md

@@ -137,15 +137,18 @@ Scribe-Android is developed using the [Kotlin](https://kotlinlang.org/) coding l
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> -   e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-Android.git`
+> -   e.g. Cloning (with submodules) now becomes `git clone git@github.com:<your-username>/Scribe-Android.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
+# Clone your fork of the repo into the current directory (including submodules).
 git clone https://github.com/<your-username>/Scribe-Android.git
 # Navigate to the newly cloned directory.
 cd Scribe-Android

app/build.gradle.kts

@@ -307,13 +307,13 @@ tasks.register<Copy>("moveFromi18n") {
     destinationDir = file("src/main/res")
 
     val locales =
-        file("src/main/assets/i18n/Scribe-i18n/values")
+        file("src/main/assets/i18n/i18n/values")
             .listFiles()
             ?.filter { it.isDirectory }
             ?.map { it.name }
             ?: emptyList()
     locales.forEach { locale ->
-        val fromDir = file("src/main/assets/i18n/Scribe-i18n/values/$locale/")
+        val fromDir = file("src/main/assets/i18n/i18n/values/$locale/")
         val targetDir =
             if (locale == "en-US") {
                 "values"