pojntfx
diff --git a/‎Makefile
Lines changed: 6 additions & 3 deletions b/‎Makefile
Lines changed: 6 additions & 3 deletions
diff --git a/‎docs/main.md
Lines changed: 25 additions & 0 deletions b/‎docs/main.md
Lines changed: 25 additions & 0 deletions
diff --git a/‎docs/static/cheatsheet.pdf
7.97 MB b/‎docs/static/cheatsheet.pdf
7.97 MB
diff --git a/‎docs/static/qr.png
821 Bytes b/‎docs/static/qr.png
821 Bytes
@@ -1,14 +1,17 @@
 all: build
 
+qr:
+	docker run -v "$(PWD):/qr:z" -e QR_TEXT="$$(sed -n '4 p' docs/metadata.txt)" -e QR_FILE=docs/static/qr.png valien/docker-qr-generator
+
 .PHONY: docs
-docs:
+docs: qr
 	mkdir -p out/docs
 	if [ -d "docs/static" ]; then cp -r docs/static out/docs; fi
 	echo "<!DOCTYPE html><meta charset="utf-8"><meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"><meta name=\"description\" content=\"$$(sed -n '2 p' docs/metadata.txt)\"><link rel=\"stylesheet\" href=\"https://unpkg.com/marx-css/css/marx.min.css\"><title>$$(sed -n '1 p' docs/metadata.txt)</title><main><h1>$$(sed -n '1 p' docs/metadata.txt)</h1><p>$$(sed -n '2 p' docs/metadata.txt)</p><hr><a href=\"$$(sed -n '4 p' docs/metadata.txt)\" target=\"_blank\">📃 View source (✍️ $$(sed -n '3 p' docs/metadata.txt))</a><br><a href=\"$$(sed -n '5 p' docs/metadata.txt)\" download=\"$$(sed -n '1 p' docs/metadata.txt).zip\">📥 Download all as ZIP</a><hr><div>You may do the following:</div><ul>" > "out/docs/index.html"
 	for document in docs/*.md; do\
 		echo "Compiling $${document} ..." ;\
-    	docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --resource-path=docs --pdf-engine=xelatex -o "out/$${document}.pdf" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --resource-path=docs --toc --self-contained -t html5 -o "out/$${document}.html" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --resource-path=docs --self-contained -t slidy --slide-level 3 -o "out/$${document}.slides.html" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --resource-path=docs -t beamer --slide-level 3 --pdf-engine=xelatex -o "out/$${document}.slides.pdf";\
-		echo "<li><a href=\"$${document#docs/}.html\" target=\"_blank\">🌐 View $${document#docs/} in your browser</a> (also available as <a href=\"$${document#docs/}.slides.html\" target=\"_blank\">slides</a>) or <a href=\"$${document#docs/}.pdf\" target=\"_blank\">📥 download $${document#docs/} as PDF</a> (also available as <a href=\"$${document#docs/}.slides.pdf\" target=\"_blank\">slides</a>)" >> "out/docs/index.html";\
+    	docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --variable urlcolor=blue --shift-heading-level-by=-1 --number-sections --resource-path=docs --pdf-engine=xelatex -o "out/$${document}.pdf" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --number-sections --resource-path=docs --toc --toc-depth=6 --katex --self-contained -t html5 -o "out/$${document}.html" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --number-sections --resource-path=docs --katex --self-contained -t slidy --slide-level 3 -o "out/$${document}.slides.html" & docker run -v "$(PWD):/data:z" pandoc/latex "$${document}" --variable urlcolor=blue --shift-heading-level-by=-1 --number-sections --resource-path=docs -t beamer --slide-level 3 --pdf-engine=xelatex -o "out/$${document}.slides.pdf";\
+		echo "<li><a href=\"$${document#docs/}.html\" target=\"_blank\">🌐 View $${document#docs/} in your browser</a> (also available as <a href=\"$${document#docs/}.slides.html\" target=\"_blank\">slides</a>) or <a href=\"$${document#docs/}.pdf\" target=\"_blank\">📜 open $${document#docs/} as PDF</a> (also available as <a href=\"$${document#docs/}.slides.pdf\" target=\"_blank\">slides</a>)" >> "out/docs/index.html";\
 	done
 	echo "</ul><div><strong><em>$$(sed -n '6 p' docs/metadata.txt)</em></strong></div></main>" >> "out/docs/index.html"
 	mkdir -p "out/release"
 
@@ -5,6 +5,31 @@
 
 # Uni Algodat Notes
 
+## Introduction
+
+### Contributing
+
+These study materials are heavily based on [professor Toenniessen's "Algorithmen und Datenstrukturen" lecture at HdM Stuttgart](https://www.hdm-stuttgart.de/vorlesung_detail?vorlid=5212224).
+
+**Found an error or have a suggestion?** Please open an issue on GitHub ([github.com/pojntfx/uni-algodat-notes](https://github.com/pojntfx/uni-algodat-notes)):
+
+![QR code to source repository](./static/qr.png){ width=150px }
+
+If you like the study materials, a GitHub star is always appreciated :)
+
+### License
+
+![AGPL-3.0 license badge](https://www.gnu.org/graphics/agplv3-155x51.png){ width=128px }
+
+Uni Algodat Notes (c) 2021 Felicitas Pojtinger and contributors
+
+SPDX-License-Identifier: AGPL-3.0
+\newpage
+
+## Cheatsheet
+
+I created a hand-written cheatsheet which contains the most important points; you can print it (use a printer with at least 2400 DPI) for use in the exam: [Cheatsheet](./static/cheatsheet.pdf)
+
 ## Themen
 
 - Einleitung