aboutsummaryrefslogtreecommitdiffstats
path: root/locale/README.md
diff options
context:
space:
mode:
authorMatthew Lemon <y@yulqen.org>2024-12-31 16:12:42 +0000
committerMatthew Lemon <y@yulqen.org>2024-12-31 16:12:42 +0000
commit38f02f15781eb251cfd94f6467d2fc8e7fdf9556 (patch)
tree1a8b680497238a46ecf47cb7dc17856f087dc878 /locale/README.md
parentc74ea9e6b4af97be26029334868fa3264032c2d3 (diff)
More comprehensive cleanup and refactor
- **Removal of Unused Files and Directories:** Deleted multiple files and directories that were no longer in use, including configuration files (e.g., `.gitattributes`, `.gitlab-ci.yml`, Docker-related configurations, and documentation files). - **Script and Build Configuration Cleanup:** Removed deployment scripts and Dockerfiles that were outdated, redundant, or no longer aligned with current project requirements. - **Documentation Purge:** Cleared out the documentation directory, including various Sphinx configuration files and content, which are no longer deemed necessary for the project's current state. - **Localization Files Delete:** Removed translation files across multiple languages that were not in use, streamlining localization efforts. - **Test Files Deletion:** Cleaned up test-related files that had no relevance to the remaining codebase. This clean-up aims to enhance project clarity, reduce unnecessary clutter, and set the stage for a more efficient development environment moving forward.
Diffstat (limited to 'locale/README.md')
-rw-r--r--locale/README.md32
1 files changed, 0 insertions, 32 deletions
diff --git a/locale/README.md b/locale/README.md
deleted file mode 100644
index 9911fec..0000000
--- a/locale/README.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# Translations
-
-Start by configuring the `LANGUAGES` settings in `base.py`, by uncommenting languages you are willing to support. Then, translations strings will be placed in this folder when running:
-
-```bash
-docker compose -f local.yml run --rm django python manage.py makemessages -all --no-location
-```
-
-This should generate `django.po` (stands for Portable Object) files under each locale `<locale name>/LC_MESSAGES/django.po`. Each translatable string in the codebase is collected with its `msgid` and need to be translated as `msgstr`, for example:
-
-```po
-msgid "users"
-msgstr "utilisateurs"
-```
-
-Once all translations are done, they need to be compiled into `.mo` files (stands for Machine Object), which are the actual binary files used by the application:
-
-```bash
-docker compose -f local.yml run --rm django python manage.py compilemessages
-```
-
-Note that the `.po` files are NOT used by the application directly, so if the `.mo` files are out of dates, the content won't appear as translated even if the `.po` files are up-to-date.
-
-## Production
-
-The production image runs `compilemessages` automatically at build time, so as long as your translated source files (PO) are up-to-date, you're good to go.
-
-## Add a new language
-
-1. Update the [`LANGUAGES` setting](https://docs.djangoproject.com/en/stable/ref/settings/#std-setting-LANGUAGES) to your project's base settings.
-2. Create the locale folder for the language next to this file, e.g. `fr_FR` for French. Make sure the case is correct.
-3. Run `makemessages` (as instructed above) to generate the PO files for the new language.