From 3046f0290310161b9875f7ae8a894473175ce975 Mon Sep 17 00:00:00 2001
From: Tobias Pape <tobias@netshed.de>
Date: Fri, 3 Mar 2017 11:41:09 +0100
Subject: [PATCH] Care for Readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 hpitr.dtx | 14 ++++++++++----
 2 files changed, 53 insertions(+), 4 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d132f6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+hpitr
+  Copyright (c) Tobias Pape <tobias.pape at hpi.uni-potsdam.de>
+  2017/03/03 v1.5
+  A unified class for Technical Reports at the HPI
+
+This consititutes the LaTeX class to creat technical reports at the
+Plattner Institute, Potsdam in conjunction with the Universitätsverlag
+Potsdam. To maintain a unified appearance, this class provides macrotypographic
+(like paper size and general layout) and microtypographic (like fonts and their
+adjustment) settings.
+
+ ---
+
+Diese LaTeX-Klasse dient zur Erstellung von technischen Berichten
+am Hasso-Plattner-Institut, Potsdam, in Zusammenarbeit mit dem
+Universitätsverlag Potsdam. Zur Erhaltung eines einheitlichen
+Erscheinungsbildes bietet diese Klasses Einstellungen zu Makrotypographie (wie
+Papiergröße, allgemeines Layout) und auch zur Detailtypographie (wie
+Schriftwahl).
+
+
+-------------------------------------------------------------------------------
+Note: To generate all files, you should simply call
+
+    pdftex -shell-escape hpitr.dtx
+
+If you are using MiKTeX you have to use
+
+    pdftex --enable-write18 hpitr.dtx
+
+to fully enable shell escapes which are also known as \write18 feature.
+
+All ltx files should be installed together with all pdf files at documentation
+folder. The sty file together with all def files should be installed at latex
+package folder.
+
+But maybe your distributor already distributes a ready for installation
+package, so you do not need to create files and copy them yourself.
+
+-------------------------------------------------------------------------------
+
+Prepared files (class, documentation) are available for releases at
+<https://github.com/HPI-SWA-Lab/hpitr/releases>
diff --git a/hpitr.dtx b/hpitr.dtx
index dd80785..56e3cca 100644
--- a/hpitr.dtx
+++ b/hpitr.dtx
@@ -65,7 +65,7 @@
 %<*!README>
 [%
 %</!README>
-  2015/12/02 v1.2
+  2017/03/03 v1.5
 %<!README>^^J
   A unified class for Technical Reports at the HPI
 %<*!README>
@@ -98,6 +98,7 @@
 % \changes{v1.4}{2016/09/01}{Fix compatibility (\ghissue{2}, \ghissue{4},
 % \ghissue{5}), add \cs{extdash} (\ghissue{8}),  announce automatic chapter
 % labels (\ghissue{15}), robustify with \cs{hardwrap} (\ghissue{16})}
+% \changes{v1.5}{2017/03/03}{Expand README a little bit}
 % \GetFileInfo{hpitr.dtx}
 %^^A ==========================================================================
 %^^A ==========================================================================
@@ -294,6 +295,7 @@ without this file.
   \file{example-proceedings.tex}{\from{hpitr.dtx}{example,proceedings}}%
   \file{example-inproceedings.tex}{\from{hpitr.dtx}{example,inproceedings,article}}%
   \file{README.txt}{\from{hpitr.dtx}{README}}%
+  \file{README.md}{\from{hpitr.dtx}{README}}%
 }%
 %    \end{macrocode}
 % After file generation, wie use shell escapes (aka \verb|\write18| feature) to
@@ -304,7 +306,6 @@ without this file.
   \Msg{* \space\space done.}
 }
 
-\immediate\write18{cp README.txt README || copy README.txt README}
 \immediate\write18{lualatex -interaction=nonstopmode hpitr.ltx}
 \immediate\write18{mkindex hpitr}
 \immediate\write18{lualatex -interaction=nonstopmode hpitr.ltx}
@@ -2953,11 +2954,11 @@ Schriftwahl).
 -------------------------------------------------------------------------------
 Note: To generate all files, you should simply call
 
-      pdftex -shell-escape hpitr.dtx
+    pdftex -shell-escape hpitr.dtx
 
 If you are using MiKTeX you have to use
 
-     pdftex --enable-write18 hpitr.dtx
+    pdftex --enable-write18 hpitr.dtx
 
 to fully enable shell escapes which are also known as \write18 feature.
 
@@ -2967,6 +2968,11 @@ package folder.
 
 But maybe your distributor already distributes a ready for installation
 package, so you do not need to create files and copy them yourself.
+
+-------------------------------------------------------------------------------
+
+Prepared files (class, documentation) are available for releases at  
+<https://github.com/HPI-SWA-Lab/hpitr/releases>
 %</README>
 %<*manual>
 This manual gives a concise usage guide for the \texttt{hpitr} class, used to