docs: add instructions to add/edit your language

SaadBazaz · SaadBazaz · commit f052d38910b8 · 2025-07-20T15:33:07.000+02:00
diff --git a/README.md b/README.md
@@ -53,6 +53,9 @@ You can also try out UniversalPython in our [live online demo](https://universal
 ### UniversalPython in Jupyter
 Install our Jupyter Kernel to easily use UniversalPython in Jupyter Notebook or Jupyter Lab. Instructions are here: https://github.com/UniversalPython/universalpython_kernel
 
+### Want to add your language? Or edit one?
+Follow the documentation [here](./universalpython/languages/README.md) to add a new human language, or edit an existing one.
+
 ### Build and release
 Install packaging dependencies:
 ```bash
diff --git a/universalpython/languages/README.md b/universalpython/languages/README.md
@@ -0,0 +1,14 @@
+## Adding a new language
+
+- Simply make a new folder here with the **two-letter** language code of your language.
+For example, German is `de`, Korean is `ko`. You can find yours [here](https://www.iban.com/country-codes).
+
+Make sure it's in lowercase!
+
+- In that folder, add two files:
+  - An empty `__init__.py` (this makes it packageable with the rest of the languages). You don't need to add anything inside!
+  - A `default.yaml` file which contains the mappings of the language. You can take [this one](./de/default.yaml) as a base template. 
+
+## Editing an existing language
+
+Simply edit the `default.yaml` of your preferred language. We currently don't have versioning or automated-human-testing involved, so it's more of an honor system.
