Various small improvements to the README

This commit is contained in:
Waldir Pimenta 2025-02-08 10:09:19 +00:00
parent c4fef80b28
commit 2b6fcd884c

View file

@ -1,8 +1,7 @@
# Custom files for git.friendi.ca
These files are the cutsom files for git.friendi.ca.
They are overriding the default template files of Forgejo.
The content of `custom` is mounted inside the Docker container at `/var/lib/gitea/custom`.
These are the custom files for git.friendi.ca, which override the default template files of Forgejo.
The content of the `custom` directory is mounted inside the Docker container at `/var/lib/gitea/custom`.
## Translation
@ -10,17 +9,17 @@ Translation of the strings can be done at [Transifex](https://www.transifex.com/
## Workflow
1. Update the strings at the top of the `generate_home_tmpl.py` file, those that start with a `str_` in the name.
1. Update the strings at the top of the `generate_home_tmpl.py` file those that start with a `str_` in the name.
2. Extract them with `pygettext -p ./lang/C/ generate_home_tmpl.py`
3. Commit the new `messages.pot` file and push it to the repository at git.friendi.ca
4. Wait for Transifex to pick up the changes and the translation teams to make the new translations
5. Download the finished translations to `lang/$lngcode/LC_MESSAGES/messages.pot`
6. Edit the `messages.pot` file and set the characterset to UTF-8.
5. Download the finished translations to `lang/$langcode/LC_MESSAGES/messages.pot`
6. Edit the `messages.pot` file and set the character set to UTF-8:
`"Content-Type: text/plain; charset=UTF-8\n"`
7. Convert the `messages.pot` file to `messages.mo` using `msgfmt messages.pot`
8. Run `python3 generate_home_tmpl.py` it will recreate the `custom/templates/home.tmpl` file
8. Run `python3 generate_home_tmpl.py` to recreate the `custom/templates/home.tmpl` file
9. Upload that file and copy it to the `custom/templates/` directory of the gitea instance.
## License
The python script to generate the template file has been released under the terms of the MIT license.
The Python script to generate the template file has been released under the terms of the MIT license.