added qucikstart docker section to readme

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
index eacceae..f3cf683 100755
--- a/README.md
+++ b/README.md
@@ -45,6 +45,28 @@ apt-get update
 
 Now proceed as described on unter [Installation](#installation).
 
+## Quickstart using Docker
+
+Run the core and two example source streams
+```
+docker run -it --rm --name=voctocore c3voc/voctomix core
+docker run -it --rm --name=cam1 --link=voctocore:corehost c3voc/voctomix gstreamer/source-videotestsrc-as-cam1.sh
+docker run -it --rm --name=bg --link=voctocore:corehost c3voc/voctomix gstreamer/source-videotestsrc-as-background-loop.sh
+```
+
+Run the GUI 
+```
+xhost +local:$(id -un)
+touch /tmp/vocto/configgui.ini
+docker run -it --rm --name=gui --env=gid=$(id -g) --env=uid=$(id -u) --env=DISPLAY=:0 --link=voctocore:corehost \
+  -v /tmp/vocto/configgui.ini:/opt/voctomix/voctogui/config.ini -v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth c3voc/voctomix gui
+```
+
+show more commands availabe
+```
+docker run -it --rm c3voc/voctomix help
+docker run -it --rm c3voc/voctomix examples
+```
 
 ## A word on CPU-Usage
 Voctomix requires a fair amount of CPU-Time to run in the default configuration of 1920×1080 at 25fps. Our Production-Systems have these CPUs: `Intel Core i7-3770 CPU 4x 3.40GHz` but we're also experimenting with newer ones like these: `Intel Core i7-6700K, 4x 4.00GHz`.