From 0ac7a65d7b09ee44b1cef90907e87b70921c51d7 Mon Sep 17 00:00:00 2001
From: Jakob Moser <moser@cl.uni-heidelberg.de>
Date: Tue, 8 Mar 2022 14:06:43 +0100
Subject: [PATCH] Add about section

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

diff --git a/README.md b/README.md
index 55a2391..185d8b8 100644
--- a/README.md
+++ b/README.md
@@ -41,4 +41,30 @@ This will take a few seconds, in which the container starts, xle parses the sent
 Note that the `xle` specified in the `docker run` command is the name of the tag you've given the image when building, _not_ the command to be executed (although under the hood the container will call a Linux command also called `xle`).
 </details>
 
+## :page_with_curl: About
+
+Here, a more detailed explanation of the relevant files is given. The used sources are marked with :books:.
+
+### `Dockerfile`
+
+The Dockerfile specifies the steps with which the image is built. As a first step, we install dependencies:
+
+* `xvfb`: X server, to allow XLE to display parse windows
+* `imagemagick`: To take screenshots from the XLE parse windows
+* `ca-certificates`: To verify the HTTPS connection to the external XLE repository
+
+:books: [Running X applications headless using Xvfb][xvfb]
+
+After that, we configure the external repository "Zinnwerk" which provides us with a copy of the XLE application.
+
+:books: [Instructions to connect to a third-party repository][3rd-repo-debwiki] <br />
+:books: [How to add a third-party repo. and key in Debian?][3rd-repo-se] <br />
+:books: [apt-key Is Deprecated. How To Add OpenPGP Repository Signing Keys Without It On Debian, Ubuntu, Linux Mint, Pop!_OS, Etc.][3rd-repo-lu]
+
+As a last step, we configure the entry point. The entry point is a script that is started inside the container whenever someone creates runs a container.
+
 [xle]:https://ling.sprachwiss.uni-konstanz.de/pages/xle/
+[xvfb]:https://blog.kagesenshi.org/2007/06/running-x-applications-headless-using.html
+[3rd-repo-debwiki]:https://wiki.debian.org/DebianRepository/UseThirdParty#Instructions_to_connect_to_a_third-party_repository
+[3rd-repo-se]:https://unix.stackexchange.com/questions/332672/how-to-add-a-third-party-repo-and-key-in-debian
+[3rd-repo-lu]:https://www.linuxuprising.com/2021/01/apt-key-is-deprecated-how-to-add.html
-- 
GitLab