diff --git a/README.md b/README.md index e69de29..117159c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,32 @@ +# ForeignThon + +> Write Python in any human language. + +ForeignThon is a transpiler ecosystem that lets developers write Python using +keywords and builtins in their native language. ForeignThon is published +under the GPL v3 license and is proudly FOSS. ForeignThon is community-built and +is open for anybody to contribute. + +```bash +pip install foreignthon +which fpy +``` + +## Languages + +ForeignThon works by adding a language pack on top of the core +ForeignThon architecture, and these language packs are available in +PyPI as `foreignthon-xx`, where xx is the language code. + +```bash +pip install foreignthon-es +fpy new myproject --lang es +cd myproject && fpy run src/main.es.py +``` + + +## Documentation + +For a full guide on usage, development, and contribution, please see our docs + +→ [docs.foreignthon.dev](https://docs.foreignthon.dev)