<NME> README.rst
<BEF> docker-opengl
=============
A docker image that support rendering graphical applications, including OpenGL apps.

.. image:: https://badge.imagelayers.io/thewtex/opengl:latest.svg
  :target: https://imagelayers.io/?images=thewtex/opengl:latest
exit with the application's return code.

The session runs `Openbox <http://openbox.org>`_ as a non-root user, *user*
that has password-less sudo privileges. The browser view is an HTML5 viewer
that talks over websockets to a VNC Server. The VNC Server displays a running
Xdummy session.

To customize the Docker image for your graphical application, set the `APP`
environmental variable to the shell command required to start the application.
For example::

  ENV APP /usr/bin/my-gui-app

The `run.sh` script can be used to drive start-up. It is customizable with
flags::

  Usage: run.sh [-h] [-q] [-c CONTAINER] [-i IMAGE] [-p PORT] [-r DOCKER_RUN_FLAGS]

  This script is a convenience script to run Docker images based on
  thewtex/opengl. It:

  - Makes sure docker is available
  - On Windows and Mac OSX, creates a docker machine if required
  - Informs the user of the URL to access the container with a web browser
  - Stops and removes containers from previous runs to avoid conflicts
  - Mounts the present working directory to /home/user/work on Linux and Mac OSX
  - Prints out the graphical app output log following execution
  - Exits with the same return code as the graphical app

  Options:

    -h             Display this help and exit.
    -c             Container name to use (default opengl).
    -i             Image name (default thewtex/opengl).
    -p             Port to expose HTTP server (default 6080). If an empty
                   string, the port is not exposed.
    -r             Extra arguments to pass to 'docker run'. E.g.
                   --env="APP=glxgears"
    -q             Do not output informational messages.


See the *example* directory for a derived image and `run.sh` script that runs the
*glxgears* OpenGL demo program.

Credits
-------

This configuration was largely inspired by the `dit4c project <https://dit4c.github.io>`_.

<MSG> Fill out README.

<DFF> @@ -1,6 +1,31 @@
 docker-opengl
 =============
-A docker image that support rendering graphical applications, including OpenGL apps.
+A docker image that supports rendering graphical applications, including OpenGL apps.
 
 .. image:: https://badge.imagelayers.io/thewtex/opengl:latest.svg
   :target: https://imagelayers.io/?images=thewtex/opengl:latest
+
+Overview
+--------
+
+This Docker image supports portable, CPU-based graphical application
+rendering, including rendering OpenGL-based applications. An X session is
+running on display `:0` and can be viewed through HTML5 viewer served at port
+6080.
+
+Run
+---
+
+To run::
+
+  docker run --rm -p 6080:6080 thewtex/opengl
+
+And go to `http://localhost:6080` to view and interact with the session.
+
+The session runs `Openbox <http://openbox.org>`_ as a non-root user, *user*
+that has password-less sudo privileges.
+
+Credits
+-------
+
+This configuration was largely inspired by the `dit4c project <https://dit4c.github.io>`_.

Fill out README.