added readme

Reviewed-on: #6

README.md

@@ -1 +1,118 @@
-# foreignthon-zh
+# foreignthon-zh
+
+Chinese language pack for [ForeignThon](https://foreignthon.keshavanand.net/) — write Python in 中文.
+
+---
+
+## Install
+
+```bash
+pip install foreignthon foreignthon-zh
+```
+
+---
+
+## Example
+
+**`fizzbuzz.zh.py`**
+
+```python
+定义 fizzbuzz(n):
+    对于 i 在 范围(1, n + 1):
+        如果 i % 15 == 0:
+            打印("FizzBuzz")
+        不然 i % 3 == 0:
+            打印("Fizz")
+        不然 i % 5 == 0:
+            打印("Buzz")
+        否则:
+            打印(i)
+
+fizzbuzz(20)
+```
+
+Compiles to standard Python:
+
+```python
+def fizzbuzz(n):
+    for i in range(1, n + 1):
+        if i % 15 == 0:
+            print("FizzBuzz")
+        elif i % 3 == 0:
+            print("Fizz")
+        elif i % 5 == 0:
+            print("Buzz")
+        else:
+            print(i)
+
+fizzbuzz(20)
+```
+
+Run it directly:
+
+```bash
+fpy run fizzbuzz.zh.py
+```
+
+---
+
+## Keyword reference
+
+| Python | 中文 |
+|---|---|
+| `if` | `如果` |
+| `else` | `否则` |
+| `elif` | `不然` |
+| `for` | `对于` |
+| `while` | `只要` |
+| `def` | `函数` / `定义` |
+| `class` | `类` / `类别` |
+| `return` | `返回` |
+| `import` | `导入` |
+| `from` | `从` |
+| `as` | `名` |
+| `in` | `在` |
+| `and` | `和` |
+| `or` | `或` |
+| `not` | `不` |
+| `True` | `真` |
+| `False` | `假` |
+| `None` | `空` |
+| `print` | `打印` / `写` |
+| `input` | `扫描` |
+| `len` | `长度` |
+| `range` | `范围` |
+| `lambda` | `匿名` / `λ` |
+| `yield` | `产生` |
+| `async` | `非同步` |
+| `await` | `等` |
+
+Full mapping: [`zh.json`](https://git.keshavanand.net/foreign-thon/foreignthon-zh/raw/branch/main/src/foreignthon_zh/zh.json)
+
+---
+
+## Start a project
+
+```bash
+fpy new myproject --lang zh
+cd myproject
+fpy run src/main.zh.py
+```
+
+---
+
+## Documentation
+
+→ [foreignthon.keshavanand.net](https://foreignthon.keshavanand.net/)
+
+---
+
+## Contributing
+
+Found a missing translation or a better keyword choice? Open an issue or PR — no access to the core repo needed.
+
+---
+
+## License
+
+GPL v3

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "foreignthon-zh"
-version = "0.1.0"
+version = "0.2.0"
 description = "Chinese language pack for ForeignThon."
 license = { text = "GPL v3" }
 requires-python = ">=3.9"

src/foreignthon_zh/zh.json

@@ -87,57 +87,57 @@
     "八进制": "oct"
   },
   "exceptions": {
-    "Exception": "Exception",
+    "異常": "Exception",
-    "BaseException": "BaseException",
+    "基异常": "BaseException",
-    "ValueError": "ValueError",
+    "值异常": "ValueError",
-    "TypeError": "TypeError",
+    "类型异常": "TypeError",
-    "KeyError": "KeyError",
+    "键值异常": "KeyError",
-    "IndexError": "IndexError",
+    "索引异常": "IndexError",
-    "AttributeError": "AttributeError",
+    "属性异常": "AttributeError",
-    "NameError": "NameError",
+    "名称异常": "NameError",
-    "ImportError": "ImportError",
+    "载入异常": "ImportError",
-    "FileNotFoundError": "FileNotFoundError",
+    "档案未找到异常": "FileNotFoundError",
-    "RuntimeError": "RuntimeError",
+    "运行时异常": "RuntimeError",
-    "ZeroDivisionError": "ZeroDivisionError",
+    "除零异常": "ZeroDivisionError",
-    "SyntaxError": "SyntaxError",
+    "句法异常": "SyntaxError",
-    "AssertionError": "AssertionError",
+    "断言异常": "AssertionError",
-    "MemoryError": "MemoryError",
+    "记忆体异常": "MemoryError",
-    "OverflowError": "OverflowError",
+    "溢值异常": "OverflowError",
-    "RecursionError": "RecursionError",
+    "递归异常": "RecursionError",
-    "PermissionError": "PermissionError",
+    "权限异常": "PermissionError",
-    "TimeoutError": "TimeoutError",
+    "超时异常": "TimeoutError",
-    "SystemExit": "SystemExit",
+    "退出系统": "SystemExit",
-    "KeyboardInterrupt": "KeyboardInterrupt"
+    "键盘中断": "KeyboardInterrupt"
   },
   "error_messages": {
-    "SyntaxError": "SyntaxError",
+    "SyntaxError": "句法异常",
-    "ValueError": "ValueError",
+    "ValueError": "值异常",
-    "TypeError": "TypeError",
+    "TypeError": "类型异常",
-    "KeyError": "KeyError",
+    "KeyError": "键值异常",
-    "IndexError": "IndexError",
+    "IndexError": "索引异常",
-    "AttributeError": "AttributeError",
+    "AttributeError": "属性异常",
-    "NameError": "NameError",
+    "NameError": "名称异常",
-    "ImportError": "ImportError",
+    "ImportError": "载入异常",
-    "FileNotFoundError": "FileNotFoundError",
+    "FileNotFoundError": "档案未找到异常",
-    "ZeroDivisionError": "ZeroDivisionError",
+    "ZeroDivisionError": "除零异常",
-    "RecursionError": "RecursionError",
+    "RecursionError": "递归异常",
-    "RuntimeError": "RuntimeError",
+    "RuntimeError": "运行时异常",
-    "MemoryError": "MemoryError",
+    "MemoryError": "属性异常",
-    "OverflowError": "OverflowError",
+    "OverflowError": "属性异常",
-    "AssertionError": "AssertionError",
+    "AssertionError": "属性异常",
-    "PermissionError": "PermissionError",
+    "PermissionError": "权限异常",
-    "TimeoutError": "TimeoutError",
+    "TimeoutError": "超时异常",
-    "KeyboardInterrupt": "KeyboardInterrupt"
+    "KeyboardInterrupt": "键盘中断"
   },
   "stdlib": {
     "数学": "math",
     "系统": "sys",
     "日期时间": "datetime",
     "时间": "time",
-    "random": "random",
+    "随机": "random",
-    "collections": "collections",
+    "收藏": "collections",
-    "pathlib": "pathlib",
+    "路径库": "pathlib",
-    "re": "re"
+    "正则表达式": "re"
   },
   "postfix_keywords": []
 }