From 2e4f7f403f8fe65a7c504c1e1e02f16f0a3de426 Mon Sep 17 00:00:00 2001 From: Fred Lifton Date: Fri, 12 Sep 2014 17:33:10 -0700 Subject: [PATCH] Edits and revisions to README-content.md. --- hylang/README-content.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/hylang/README-content.md b/hylang/README-content.md index 3e762b22dac9..bbade10a40fa 100644 --- a/hylang/README-content.md +++ b/hylang/README-content.md @@ -1,25 +1,32 @@ # What is hylang? -Hy (alternately, Hylang) is a dialect of the Lisp programming language designed to interoperate with Python by translating expressions into Python's abstract syntax tree (AST). Similar to Clojure's mapping of s-expressions onto the JVM, Hy is meant to operate as a transparent Lisp front end to Python's abstract syntax. Hy also allows for Python libraries (include the standard library) to be imported and accessed alongside Hy code with a compilation step, converting the data structure of both into Python's AST. +Hy (a.k.a., Hylang) is a dialect of the Lisp programming language designed to +interoperate with Python by translating expressions into Python's abstract syntax tree +(AST). Similar to Clojure's mapping of s-expressions onto the JVM, Hy is meant to operate +as a transparent Lisp front end to Python's abstract syntax. Hy also allows for Python +libraries (include the standard library) to be imported and accessed alongside Hy code +with a compilation step, converting the data structure of both into Python's AST. > [hy.readthedocs.org/en/latest/](http://hy.readthedocs.org/en/latest/) # How to use this image -## Create a `Dockerfile` in your hylang project. +## Create a `Dockerfile` in your Hylang project. FROM hylang:0.10.0 COPY . /usr/src/myapp WORKDIR /usr/src/myapp CMD [ "hy", "./your-daemon-or-script.hy" ] -Then build and run the docker image. +You can then build and run the Docker image. docker build -t my-hylang-app docker run -it --rm --name my-running-app my-hylang-app -## Run a single hylang script. +## Run a single Hylang script. -For many single file projects, it may not be convenient to write a `Dockerfile` for your project. In such cases, you can run a hylang script by using the hylang docker image directly. +For many simple, single file projects, you may find it inconvenient to write a complete +`Dockerfile`. In such cases, you can run a Hylang script by using the Hylang Docker image +directly. docker run -it --rm --name my-running-script -v "$(pwd)":/usr/src/myapp -w /usr/src/myapp hylang:0.10.0 hy your-daemon-or-script.hy