From 3d487b48bfda82ba3a75fd0fda6e4e861dc0ff4a Mon Sep 17 00:00:00 2001 From: Veit Heller Date: Sun, 15 Jun 2014 21:44:14 +0200 Subject: [PATCH] Added README --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1be93d4..fac4fc6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,39 @@ _ = -_ allows you to write Python scripts by using only _ +This repository is a Python port of mames [\_ module](https://github.com/mame/_) +that allows you to write scripts by using _ exclusively. + +Overview +-------- + +The following __script__ is a "Hello, world!"" program in \_: + +``` +____ _ _____ ____ __ _ ___ ______ ____ ____ _ ___ ____ __ +___ __ _ _____ __ _ ____ ___ _ _ ___ _____ ______ ____ _ _ +____ _ _ ____ _ ____ __ __ ___ _ ______ ___ ____ __ ______ +____ _ ____ ____ __ _ ____ _ _ ___ _____ _____ _ ______ +____ __ _ ____ __ _ ______ +``` + +As you can see, it uses very advanced and fancy features of modern linguistics +to model the human language exactly in code. + +As in mames' original version, you can create such a __script__ easily: + +* __script__(YourCodeAsAStringHere) will encode it raw +* __ruby_script__(YourCode) will encode it and add a "require" +* __python_script__(YourCode) will encode it and add an "import" + +Install +------- +````python setup.py install``` + +Drawbacks +--------- + +I still cope with Pythons' differences to Ruby. That means by now you have +to keep the script as a string and give it to `_`'s `to_be_exec()` function. + +Not cool, I know. I am working on it.