Create TRANSLATIONS.md

docs/TRANSLATIONS.md

@@ -0,0 +1,59 @@
+# Translation guide #
+
+This guide will walk you through the process of creating translations for infinitechess.org. What it won't tell you is how to setup your workspace, please refer to [SETUP.md](./SETUP.md). It is assumed you have gone through it (you can ignore step 5).
+
+## Navigaton ##
+
+Anything that matters to you as a translator should be located in [translation](../translation/) directory. Translation files are stored in TOML format (you can read more about its syntax [here](https://toml.io/)). Generally it is really aproachable format, you should be able to get hang of it pretty quickly.
+
+## Translation files ##
+
+### Name ###
+
+Each file is named after its language [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag). BCP 47 tags are composed in this format (notice the capitalization):
+
+`lng-(script)-REGION-(extensions)`
+
+For example `en-US` for American Enligsh, `sv` for Sweedish, `zh-Hant-HK` for Chinese spoken in Hong Kong written in traditional script.
+
+You should name your file this way and only this way otherwise it won't be correctly detected.
+
+### Content ###
+
+As stated before translation files are TOML format consits of keys and values, table headers and comments.
+
+```toml
+[table-header]
+# Comment
+key1 = "value1"
+key2 = "value2"
+```
+
+> [!IMPORTANT]
+> **You should only touch values and comments**.
+
+## Translating process ##
+
+In case you are translating language that is currently not present in the project you start the process by copying [en-US.toml](../translation/en-US.toml) and renaming it as described above. If you are updating existing language, the only thing you need to do is to update `version` variable on top of your TOML document to value of `version` variable in [en-US.toml](../translation/en-US.toml).
+
+> [!IMPORTANT]
+> You should always use [en-US.toml](../translation/en-US.toml) as a reference. It is the only file that is up to date and comes straight from the developers. Do not use any other files!
+
+Then you start test server with `npx nodemon` and start translating. If you head to your browser at adress `localhost:3443` the website should be there and it should authomatically update as you make your changes (after reloading the page). Make sure you have selected the language that you are editing in the websites UI.
+
+In case you are updating existing language and you aren't sure what has changed since the last update you can view changes of `en-US.toml` [here](https://github.com/Infinite-Chess/infinitechess.org/commits/main/translation/en-US.toml).
+
+> [!IMPORTANT]
+> If there is a HTML tag in field you should translate, do not touch it!
+> 
+> Example of html tag:
+> ```html
+> <a href="https://www.google.com"> Hello World </a>
+> ```
+> In this example you should touch only the words *Hello World*.
+
+Now that you have finished you should open a pull request as described in [SETUP.md](./SETUP.md).
+
+## Conclusion ##
+
+Thank you for your contribution! In case you have any troubles or questions you can join [the discord](https://discord.gg/NFWFGZeNh5).