diff --git a/README.md b/README.md index 882711f..9355500 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,37 @@ [![Build Status](https://travis-ci.org/blue-jam/rime-docker.svg?branch=master)](https://travis-ci.org/blue-jam/rime-docker) A docker image including rime, C++, Java, Kotlin, and Python. + +[Docker Hub](https://hub.docker.com/r/bluejamkmy/rime-docker) + +## Usage + +You may have to run `docker` commands as a super user. + +1. Pull `rime-docker` image from Docker Hub by + + ``` + $ docker pull bluejamkmy/rime-docker + ``` + +1. Save [`Dockerfile`](Dockerfile.example) in your rime project directory: + + ```Dockerfile + FROM bluejamkmy/rime-docker + + COPY . /rime_project + + WORKDIR /rime_project + ``` + +1. Build a docker image for your project by + + ``` + $ docker build -t myrime . + ``` + +1. Run your container by + + ``` + $ docker run -it myrime rime test + ```