From 513bdc506b9702f3fdfc721f69fc04178f97b8f6 Mon Sep 17 00:00:00 2001
From: jaschop <1k5o@tuta.io>
Date: Thu, 28 Sep 2023 17:55:09 +0200
Subject: [PATCH 1/2] added Dockerfile & docker build instructions in README

also some cleaning up of README
---
 Dockerfile |  8 ++++++++
 README.md  | 35 ++++++++++++-----------------------
 2 files changed, 20 insertions(+), 23 deletions(-)
 create mode 100755 Dockerfile

diff --git a/Dockerfile b/Dockerfile
new file mode 100755
index 0000000..be3a26f
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,8 @@
+FROM sphinxdoc/sphinx-latexpdf
+
+RUN pip3 install sphinxcontrib-plantuml
+RUN apt-get update && apt-get install plantuml locales-all -y
+ENV LC_ALL="de_DE.UTF8"
+WORKDIR /doc
+CMD ["make", "latexpdf", "singlehtml"]
+
diff --git a/README.md b/README.md
index b41eec5..a715ca9 100644
--- a/README.md
+++ b/README.md
@@ -13,15 +13,6 @@ Es existiert jweils ein Repo für den Frontend- und den Backend-Code:
 - https://git.wtf-eg.de/kompetenzinventar/ki-frontend.git
 - https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
 
-## Features ##
-
-TBD
-
-## Contents
-- [Features](#features)
-- [Building](#building)
-- [Contributing](#contributing)
-
 ## Building
 
 Building the ki-doku depends on the following Python packages:
@@ -30,14 +21,21 @@ Building the ki-doku depends on the following Python packages:
 
 as well as the system dependency `plantuml`, which you can get e.g. with `apt install plantuml`
 
-Building/using the ki-backend depends on python and flask, see the repo's environment specification for details.
+### Building with Docker
+
+You can also build the docs using docker:
+
+    docker build -t ki-doku-builder .
+    docker run -v $(pwd)/doc:/doc ki-doku-builder
+
+    # results:
+    #   ./doc/build/latex/kompetenzinventar.pdf
+    #   ./doc/build/singlehtml/
 
-<!-- ROADMAP -->
 ## Roadmap
 
 See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
 
-<!-- CONTRIBUTING -->
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@@ -48,23 +46,14 @@ Contributions are what make the open source community such an amazing place to b
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
+(Pull requests currently require an account on our private gitea, but we faithfully await deliverance from our federated [lord and saviour](forgefed.org).)
 
-<!-- LICENSE -->
 ## License
 
 Distributed under the ??? License. See `LICENSE` for more information.
 
-<!-- CONTACT -->
 ## Contact
-<!--
-Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email
- -->
+
 Project Link: [https://git.wtf-eg.de/kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar)
 
 
-<!-- ACKNOWLEDGEMENTS -->
-## Acknowledgements
-
-* []()
-* []()
-* []()

From 1a4dcecaac5451cb321fde6f7ccb6eac2e7e0aa3 Mon Sep 17 00:00:00 2001
From: jaschop <1k5o@tuta.io>
Date: Thu, 28 Sep 2023 18:05:28 +0200
Subject: [PATCH 2/2] added docker image size warning

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

diff --git a/README.md b/README.md
index a715ca9..b47258f 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ You can also build the docs using docker:
     #   ./doc/build/latex/kompetenzinventar.pdf
     #   ./doc/build/singlehtml/
 
+Warning: the builder uses the `sphinx-latexpdf` base image, which contains an entire texlive environment, making it very large (~2.9G).
+
 ## Roadmap
 
 See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).