From e50b2754aee8ef5f9a814ca4a9ba08feb83f0bae Mon Sep 17 00:00:00 2001 From: KeshavAnandCode Date: Wed, 20 May 2026 17:29:55 -0500 Subject: [PATCH] added readme --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ddf7cda..7295c80 100644 --- a/README.md +++ b/README.md @@ -1 +1,56 @@ -# foreignthon +# ForeignThon + +Write Python in any human language. + +ForeignThon transpiles `.es.py`, `.ta.py` and more into standard Python — keywords, builtins, exceptions, all translated. Errors come back in your language too. + +```python +# main.es.py +def saludar(nombre): + retornar f"Hola, {nombre}!" + +para i en dist(3): + escribir(saludar(f"mundo {i}")) +``` + +```bash +fpy run main.es.py +# Hola, mundo 0! +# Hola, mundo 1! +# Hola, mundo 2! +``` + +## Install + +```bash +pip install foreignthon # Core +pip install foreignthon-es # Spanish +pip install foreignthon-ta # Tamil +``` + +## Quick start + +```bash +fpy new myproject --lang es +cd myproject +fpy run src/main.es.py +``` + +## Commands + +| Command | Description | +|---|---| +| `fpy new --lang ` | Scaffold a new project | +| `fpy run ` | Transpile and run | +| `fpy compile ` | Transpile to `.compiled.py` | +| `fpy decompile --lang ` | Convert Python back to a language | +| `fpy check ` | Validate without running | + +## Documentation + +→ [fpy.keshavanand.net](https://foreignthon.keshavanand.net) + +## License + +GPL v3 +