Skip to content

Commit

Permalink
small revision
Browse files Browse the repository at this point in the history
  • Loading branch information
rowr111 committed Dec 10, 2024
1 parent 4f5f4e2 commit 3f67784
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions locales/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `lib.rs` file in this crate is auto-generated by `xtask`. It must be manuall
calling `xtask generate-locales` every time changes are made to the localization strings.

## Where are the Strings?
Locale files can be added to any app by making a `locales` directory within the `apps` folder, and
Locale files can be added to any app, service, etc by making a `locales` directory within the item's top level folder, and
then placing a `i18n.json` file in there with a format like this:

```json
Expand Down Expand Up @@ -36,7 +36,7 @@ Note that "en-tts" is a locale for english/vision-impaired. `🔇` means that an
for that locale (can be used in any locale, not just speech-to-text locales). Omitting a locale
entirely without using the 🔇 character will lead to a panic.

There are also locale files `i18n.json` and `manifest.json` in the `apps` folder itself for strings relevant to menu items etc.
There are also locale files `i18n.json` and `manifest.json` in the `apps` folder itself for strings relevant to menu items etc. If you add an app you will want to add items here as well.

## How to Code with Locales
The JSON file is parsed by `xtask` into a lib.rs file which is referred to within a server by
Expand Down

0 comments on commit 3f67784

Please sign in to comment.