From 6ce85b3f8ef934685d30cc75d1900d4362175b74 Mon Sep 17 00:00:00 2001
From: Tilman Hoffbauer <tilman.hoffbauer@juforum.de>
Date: Sat, 11 Apr 2020 21:26:06 +0200
Subject: [PATCH] Add README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..589bca4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Dymola Docker
+
+## Disclaimer
+This is just an unofficial experiment by me.
+It seems to work, but no guarantee!
+This is based on the files provided by the RWTH Aachen for teaching.
+
+## Building
+You need a running docker engine and X11.
+First you need to download the files (program files (rpm) and license file).
+Copy the folder `AM_CAT_Dymola.AllLinux` and `Dymola.LIC` in the same folder as the `Dockerfile`.
+```bash
+sudo docker build -t dymola .
+```
+This may take a while.
+
+## Running
+There are a number of ways, but I use:
+```bash
+sudo docker run -it --rm -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix -v /path/to/my/dymola/workspace:/home/user/Dymola dymola
+```
+You can then run Dymola in the opened `xterm` (terminal):
+```bash
+dymola-2018-x86_64
+```
+This requires you to always set the path to the license file and the workspace on each start.