Skip to content

Edits and revisions to README-content.md. #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fredlf wants to merge 1 commit into from
Closed

Edits and revisions to README-content.md. #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions hylang/README-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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