M index.md => index.md +1 -0
@@ 9,6 9,7 @@ tool. It is an ordinary git repository, so improvements are just a push away.
- [Getting started](getting-started.md) — install hello-hut and say hello
- [Frequently asked questions](faq.md)
- [Release process](release-process.md) — how a version is tagged and announced
+- [Translating hello-hut](translating.md) — adding a language to `--lang`
## Elsewhere
A translating.md => translating.md +22 -0
@@ 0,0 1,22 @@
+# Translating hello-hut
+
+Greetings live in `src/hello_hut/translations.py` (on the `next` branch until
+0.3.0). Each entry maps a language code to a salutation:
+
+```python
+TRANSLATIONS = {
+ "en": "Hello",
+ "fr": "Bonjour",
+}
+```
+
+To add a language:
+
+- [ ] Add one line to `TRANSLATIONS`, keeping the table sorted
+- [ ] Add a case to `tests/test_cli.py`
+- [ ] Send the patch to the devel list
+
+Current languages: Arabic (مرحبا), German, English, Spanish, French,
+Japanese (こんにちは), Portuguese, Swedish and Turkish.
+
+Back to the [index](index.md).