Add README.md and rendered png to all folders except for /documents

The examples were found by ```bash $ find . -not -path '*/\.*' -type d '!' -exec test -e "{}/README.md" ';' -print ``` To do so, a cleanup-script .meta/add_readme.py was created.
MartinThoma · Nov 22, 2015 · 2de9065 · 2de9065
1 parent de1ad26
commit 2de9065
Show file tree

Hide file tree

Showing 154 changed files with 483 additions and 171 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+*.gif diff=image
+*.jpg diff=image
+*.png diff=image
diff --git a/.meta/add_readme.py b/.meta/add_readme.py
@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+import os
+from os import listdir
+from os.path import isfile, join
+
+import logging
+import sys
+
+logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s',
+                    level=logging.DEBUG,
+                    stream=sys.stdout)
+
+
+def create_readme(directory):
+    project_name = os.path.basename(directory)
+    onlyfiles = [f.lower()
+                 for f in listdir(directory)
+                 if isfile(join(directory, f))]
+    if ('%s.tex' % project_name) not in onlyfiles:
+        logging.warning("Dir '%s' has no standard .tex filename.", directory)
+        return
+    text = "Compiled example\n"
+    text += "----------------\n"
+    text += "![Example](%s.png)\n" % project_name
+    with open(os.path.join(directory, "README.md"), 'w') as f:
+        f.write(text)
+    os.system("make png -C %s" % directory)
+
+subdirs = [x[0] for x in os.walk('.')]
+subdirs = [f for f in subdirs
+           if not any([True for e in f.split('/')
+                       if e.startswith('.') and len(e) > 1])]
+for subdir in subdirs:
+    onlyfiles = [f.lower() for f in listdir(subdir) if isfile(join(subdir, f))]
+    if 'readme.md' not in onlyfiles:
+        create_readme(subdir)
diff --git a/documents/chess-chessboard-4x4/README.md b/documents/chess-chessboard-4x4/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](chess-chessboard-4x4.png)
diff --git a/documents/chess-chessboard-4x4/chess-chessboard-4x4.png b/documents/chess-chessboard-4x4/chess-chessboard-4x4.png
diff --git a/documents/chess-chessboard-shortest-game/README.md b/documents/chess-chessboard-shortest-game/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](chess-chessboard-shortest-game.png)
diff --git a/documents/chess-chessboard-shortest-game/chess-chessboard-shortest-game.png b/documents/chess-chessboard-shortest-game/chess-chessboard-shortest-game.png
diff --git a/documents/chess-chessboard-simple-example/README.md b/documents/chess-chessboard-simple-example/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](chess-chessboard-simple-example.png)
diff --git a/documents/chess-chessboard-simple-example/chess-chessboard-simple-example.png b/documents/chess-chessboard-simple-example/chess-chessboard-simple-example.png
diff --git a/documents/chess-skak-simple-example/README.md b/documents/chess-skak-simple-example/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](chess-skak-simple-example.png)
diff --git a/documents/chess-skak-simple-example/chess-skak-simple-example.png b/documents/chess-skak-simple-example/chess-skak-simple-example.png
diff --git a/documents/eaz/Makefile b/documents/eaz/Makefile
@@ -1,7 +1,33 @@
 SOURCE = eaz
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
+
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/documents/eaz/README.md b/documents/eaz/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](eaz.png)
diff --git a/documents/eaz/eaz.pdf b/documents/eaz/eaz.pdf
diff --git a/documents/eaz/eaz.png b/documents/eaz/eaz.png
diff --git a/documents/math-euklidische-normalform/README.md b/documents/math-euklidische-normalform/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](math-euklidische-normalform.png)
diff --git a/documents/math-euklidische-normalform/math-euklidische-normalform.png b/documents/math-euklidische-normalform/math-euklidische-normalform.png
diff --git a/documents/math-sylvester-diagonal-matrix/README.md b/documents/math-sylvester-diagonal-matrix/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](math-sylvester-diagonal-matrix.png)
diff --git a/documents/math-sylvester-diagonal-matrix/math-sylvester-diagonal-matrix.png b/documents/math-sylvester-diagonal-matrix/math-sylvester-diagonal-matrix.png
diff --git a/documents/size/Makefile b/documents/size/Makefile
@@ -1,10 +1,33 @@
 SOURCE = size
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
-	pdflatex $(SOURCE).tex -output-format=pdf # first run for the aux file
-	makeindex $(SOURCE)                       # now the index is generated
-	pdflatex $(SOURCE).tex -output-format=pdf # pdf with index :-)
+	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/documents/size/README.md b/documents/size/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](size.png)
diff --git a/documents/size/size.pdf b/documents/size/size.pdf
diff --git a/documents/size/size.png b/documents/size/size.png
diff --git a/documents/table-multiple-pages/README.md b/documents/table-multiple-pages/README.md
@@ -0,0 +1 @@
+Example with a very long table over multiple pages
diff --git a/documents/zwischenmiete-vertrag/README.md b/documents/zwischenmiete-vertrag/README.md
@@ -0,0 +1,2 @@
+Example for a contract - in German - about giving your apartment to somebody
+else for a short time.
diff --git a/images/basic/Makefile b/images/basic/Makefile
@@ -1,8 +1,34 @@
 SOURCE = basic
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
+	pdflatex $(SOURCE).tex -output-format=pdf
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/images/basic/README.md b/images/basic/README.md
@@ -0,0 +1 @@
+Just include an image in a document in its original size
diff --git a/images/float/Makefile b/images/float/Makefile
@@ -1,8 +1,33 @@
 SOURCE = float
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/images/float/README.md b/images/float/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](float.png)
diff --git a/images/float/float.png b/images/float/float.png
diff --git a/images/scaling/Makefile b/images/scaling/Makefile
@@ -1,8 +1,33 @@
 SOURCE = scaling
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/images/scaling/README.md b/images/scaling/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](scaling.png)
diff --git a/images/scaling/scaling.png b/images/scaling/scaling.png
diff --git a/images/side-by-side-subfig/Makefile b/images/side-by-side-subfig/Makefile
@@ -1,9 +1,34 @@
 SOURCE = side-by-side-subfig
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/images/side-by-side-subfig/side-by-side-subfig.png b/images/side-by-side-subfig/side-by-side-subfig.png
diff --git a/images/side-by-side/Makefile b/images/side-by-side/Makefile
@@ -1,9 +1,34 @@
 SOURCE = side-by-side
+DELAY = 80
+DENSITY = 300
+WIDTH = 512
 
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux *.out *.ind *.idx *.ilg *.toc *.bbl *.blg *.pyg
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
+
+gif:
+	pdfcrop $(SOURCE).pdf
+	convert -verbose -delay $(DELAY) -loop 0 -density $(DENSITY) $(SOURCE)-crop.pdf $(SOURCE).gif
+	make clean
+
+png:
+	make
+	make svg
+	inkscape $(SOURCE).svg -w $(WIDTH) --export-png=$(SOURCE).png
+
+transparentGif:
+	convert $(SOURCE).pdf -transparent white result.gif
+	make clean
+
+svg:
+	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
+	pdf2svg $(SOURCE).pdf $(SOURCE).svg
+	# Necessary, as pdf2svg does not always create valid svgs:
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/images/side-by-side/README.md b/images/side-by-side/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](side-by-side.png)
diff --git a/images/side-by-side/side-by-side.pdf b/images/side-by-side/side-by-side.pdf
diff --git a/images/side-by-side/side-by-side.png b/images/side-by-side/side-by-side.png
diff --git a/math/commutative-diagramm/README.md b/math/commutative-diagramm/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](commutative-diagramm.png)
diff --git a/math/commutative-diagramm/commutative-diagramm.png b/math/commutative-diagramm/commutative-diagramm.png
diff --git a/presentations/Tutorenschlung/presentation/README.md b/presentations/Tutorenschlung/presentation/README.md
@@ -0,0 +1 @@
+Presentation of a softskill course at KIT.
diff --git a/source-code/Pseudocode/quotes/README.md b/source-code/Pseudocode/quotes/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](quotes.png)
diff --git a/source-code/Pseudocode/quotes/quotes.png b/source-code/Pseudocode/quotes/quotes.png
diff --git a/tikz/b-tree-2-small-2/README.md b/tikz/b-tree-2-small-2/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](b-tree-2-small-2.png)
diff --git a/tikz/b-tree-2-small-2/b-tree-2-small-2.png b/tikz/b-tree-2-small-2/b-tree-2-small-2.png
diff --git a/tikz/b-tree-2-small-3/README.md b/tikz/b-tree-2-small-3/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](b-tree-2-small-3.png)
diff --git a/tikz/b-tree-2-small-3/b-tree-2-small-3.png b/tikz/b-tree-2-small-3/b-tree-2-small-3.png
diff --git a/tikz/b-tree-2-small-4/README.md b/tikz/b-tree-2-small-4/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](b-tree-2-small-4.png)
diff --git a/tikz/b-tree-2-small-4/b-tree-2-small-4.png b/tikz/b-tree-2-small-4/b-tree-2-small-4.png
diff --git a/tikz/b-tree-2-small/Makefile b/tikz/b-tree-2-small/Makefile
@@ -1,14 +1,14 @@
 SOURCE = b-tree-2-small
 DELAY = 80
 DENSITY = 300
-WIDTH = 500
+WIDTH = 512
 
 make:
 	pdflatex $(SOURCE).tex -output-format=pdf
 	make clean
 
 clean:
-	rm -rf  $(TARGET) *.class *.html *.log *.aux
+	rm -rf  $(TARGET) *.class *.html *.log *.aux *.data *.gnuplot
 
 gif:
 	pdfcrop $(SOURCE).pdf
@@ -28,4 +28,6 @@ svg:
 	#inkscape $(SOURCE).pdf --export-plain-svg=$(SOURCE).svg
 	pdf2svg $(SOURCE).pdf $(SOURCE).svg
 	# Necessary, as pdf2svg does not always create valid svgs:
-	inkscape $(SOURCE).svg --export-plain-svg=$(SOURCE).svg
+	inkscape $(SOURCE).svg --export-width=$(WIDTH) --export-plain-svg=$(SOURCE)1.svg
+	rsvg-convert -a -w 720 -f svg $(SOURCE)1.svg -o $(SOURCE).svg
+	rm $(SOURCE)1.svg
diff --git a/tikz/b-tree-2-small/README.md b/tikz/b-tree-2-small/README.md
@@ -0,0 +1,3 @@
+Compiled example
+----------------
+![Example](b-tree-2-small.png)
diff --git a/tikz/b-tree-2-small/b-tree-2-small.png b/tikz/b-tree-2-small/b-tree-2-small.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Example with a very long table over multiple pages
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Example for a contract - in German - about giving your apartment to somebody
		else for a short time.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Just include an image in a document in its original size