From 4e6b311537ac713bbe6a0b8deee3a852ae059b01 Mon Sep 17 00:00:00 2001 From: Moghedrin Date: Mon, 8 Sep 2014 12:00:32 -0600 Subject: [PATCH] Finished documentation for Hylang --- hylang/README-content.md | 18 ++++++++++++++++++ hylang/README.md | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/hylang/README-content.md b/hylang/README-content.md index dec09277..718f7698 100644 --- a/hylang/README-content.md +++ b/hylang/README-content.md @@ -5,3 +5,21 @@ Hy (alternately, Hylang) is a dialect of the Lisp programming language designed > [hy.readthedocs.org/en/latest/](http://hy.readthedocs.org/en/latest/) # How to use this image + +## Create a `Dockerfile` in your hylang project. + + FROM hylang:0.10.0 + ADD . /usr/src/myapp + WORKDIR /usr/src/myapp + CMD [ "hy", "./your-daemon-or-script.hy" ] + +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. + +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. + + 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.py diff --git a/hylang/README.md b/hylang/README.md index 9078606e..f1125e02 100644 --- a/hylang/README.md +++ b/hylang/README.md @@ -6,6 +6,24 @@ Hy (alternately, Hylang) is a dialect of the Lisp programming language designed # How to use this image +## Create a `Dockerfile` in your hylang project. + + FROM hylang:0.10.0 + ADD . /usr/src/myapp + WORKDIR /usr/src/myapp + CMD [ "hy", "./your-daemon-or-script.hy" ] + +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. + +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. + + 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.py + # User Feedback ## Issues