added readme
All checks were successful
Pack Validation CI / validate (push) Successful in 7s
Trigger Docs Rebuild / trigger (push) Successful in 2s

This commit is contained in:
2026-05-21 15:16:38 +00:00
parent 20761a9aad
commit 0ab35b8a90

121
README.md
View File

@@ -1,37 +1,126 @@
# foreignthon-ta # foreignthon-ta
Tamil language pack for ForeignThon. Tamil language pack for [ForeignThon](https://foreignthon.keshavanand.net/) — write Python in தமிழ்.
---
## Install ## Install
```bash ```bash
pip install foreignthon foreignthon-ta pip install foreignthon foreignthon-ta
``` ```
## Usage ---
```py ## Example
fpy run main.ta.py
**`fizzbuzz.ta.py`**
```python
ிரலகம fizzbuzz(n):
ஆக i உள வரம(1, n + 1):
i % 15 == 0 @@ஆன:
பதிி("FizzBuzz")
i % 3 == 0 @@இலஆன:
பதிி("Fizz")
i % 5 == 0 @@இலஆன:
பதிி("Buzz")
மறறபடி:
பதிி(i)
fizzbuzz(20)
``` ```
## What's translated This uses Tamil's natural SOV word order — the condition comes first, then the keyword with `@@`. See [Postfix Syntax](https://foreignthon.keshavanand.net/postfix-syntax/) for details.
- **Keywords** — {keywords} Compiles to standard Python:
- **Builtins** — {builtins}
- **Exceptions** — {exceptions}
- **Stdlib** — {stdlib}
{postfix_section} ```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)
```
---
## Keyword reference
| Python | தமிழ் |
|---|---|
| `if` | `ஆனால்` |
| `else` | `மற்றபடி` |
| `elif` | `இல்லைஆனால்` |
| `for` | `ஆக` |
| `while` | `வரை` |
| `def` | `நிரல்பாகம்` |
| `class` | `கோப்பு` |
| `return` | `பின்கோடு` |
| `import` | `இறக்கு` |
| `True` | `உண்மை` |
| `False` | `பொய்` |
| `None` | `ஒன்றுமில்லை` |
| `print` | `பதிப்பி` |
| `input` | `உள்ளீடு` |
| `len` | `நீளம்` |
| `range` | `வரம்பு` |
Full mapping: [`ta.json`](https://git.keshavanand.net/foreign-thon/foreignthon-ta/raw/branch/main/src/foreignthon_ta/ta.json)
---
## Postfix syntax
Tamil is SOV — the condition naturally comes before the keyword. The `@@` operator lets you write it that way:
```python
# prefix style (also valid)
ஆன x > 0:
பதிி(x)
# postfix style — natural Tamil order
x > 0 @@ஆன:
பதிி(x)
```
Both compile identically. Decompile standard Python with postfix output:
```bash
fpy decompile script.py --lang ta --postfix
```
---
## Start a project
```bash
fpy new myproject --lang ta
cd myproject
fpy run src/main.ta.py
```
---
## Documentation ## Documentation
→ https://foreignthon.keshavanand.net/ [foreignthon.keshavanand.net](https://foreignthon.keshavanand.net/)
---
## Contributing ## Contributing
Found a missing translation or a better keyword choice? Open an issue or PR — no core access needed. Found a missing translation or a better keyword choice? Open an issue or PR — no access to the core repo needed.
---
## License ## License
GPL GPL v3