From 2491b508484ee34777986ffea4fd3724add3961d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Kempka?= <kempka.michal@gmail.com>
Date: Sun, 26 Mar 2017 15:35:24 +0200
Subject: [PATCH] Added readme for dockers.

Former-commit-id: 2407eaf88ef146cf9978ac2f6204b9c6d7a84441
---
 docker/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 docker/README.md

diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 000000000..9367af0e1
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,26 @@
+Provided dockerfiles (all images use ubuntu 16.04):
+
+* **python3** - python3, vizdoom with dependecies and X11 support. By default runs [basic example](examples/python/basic.py).
+* **tensorflow** - python3, vizdoom with dependecies, tensorflow and X11 support. By default runs [tensorflow learning example](examples/python/learning_tensorflow.py).
+* **torch** - TODO
+
+# Building
+```bash
+# Uses Dockerfile in python3 directory to create image tagged vizdoom
+docker build python3 -t vizdoom 
+
+
+# Uses Dockerfile in tensorflow directory to create image tagged vizdoom_tf
+docker build tensorflow -t vizdoom_tf 
+
+```
+# Running (requires building beforehand)
+
+```
+# Run basic example in container named 'basic' ('--net=host -e DISPLAY=${DISPLAY'} is needed for X11) 
+docker run  -t --net=host -e DISPLAY=${DISPLAY} --rm --name basic vizdoom
+
+# Run tensorflow learning example in container named 'vizdoom_tf' ('--net=host -e DISPLAY=${DISPLAY'} is needed for X11)
+docker run  -t --net=host -e DISPLAY=${DISPLAY} --rm --name vizdoom_tf vizdoom_tf
+
+```