move translating.md to translating.en.md and actually write the thing

2021-05-11 13:34:05 -06:00
parent 1f0035d0a5
commit 2966eedc97
2 changed files with 44 additions and 3 deletions
@@ -0,0 +1,44 @@
+comitium is currently translated into:
+* English (en-US)
+
+Translations for literally any language not listed above are welcome.
+
+
+# Translating comitium
+
+Translating comitium is really easy!  You have to translate like twenty words
+and that's it.
+
+To start, download the YAML file with all the strings:
+[files.yaml](/comitium/tree/localizations_src/en-US/files.yaml) (if you'd prefer
+to start with a language other than English, see other languages
+[here](/comitium/tree/localizations_src/)).
+
+The file will be a series of key-value pairs and comments, it'll be laid out
+like this:  
+```
+# comment
+key1: string to translate
+another_key: another string to translate, with {{.replacements}} this time
+## more comments
+```
+
+All you do is just translate the strings after the colon (`:`), but not anything
+in the replacement brackets (`{{.replacement}}`).
+
+So to translate the line:  
+```
+feed_subscriptions_link: Currently aggregating {{.num}} capsules, gopherholes, and websites.
+```
+You'd just translate the string `Currently aggregating[...]capsules, gopherholes,
+and websites.` and leave the `feed_subscriptions_link: ` and `{{.num}}` as-is.
+
+There we go, you translate all the lines in that file (you don't need to do
+comments) and that's it!  You just translated comitium!  Email the YAML file to
+me at [alex [at] nytpu.com](mailto:alex@nytpu.com) and I'll take care of the
+rest.
+
+If you want to be extra helpful, you could also translate [the
+quickstart](/comitium/tree/doc/quickstart.en.md) and [this
+document](/comitium/tree/doc/translating.en.md), but you shouldn't feel
+obligated to do so.