summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/cs-techrep/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/cs-techrep/README')
-rw-r--r--macros/latex/contrib/cs-techrep/README64
1 files changed, 64 insertions, 0 deletions
diff --git a/macros/latex/contrib/cs-techrep/README b/macros/latex/contrib/cs-techrep/README
new file mode 100644
index 0000000000..d133b67a2d
--- /dev/null
+++ b/macros/latex/contrib/cs-techrep/README
@@ -0,0 +1,64 @@
+ -----------------------------
+ Version 0.1 of the cs-techrep class
+ Christoph P. Neumann
+ -----------------------------
+
+This LaTeX class provides a simple environment for
+technical reports in computer science and software engineering.
+
+As this class is created mainly for ourselves it does not
+contain evil low-level TeX magic but instead uses many other
+fancy LaTeX packages that we hope you have already installed.
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3c
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of LaTeX
+version 2008/05/04 or later.
+
+
+Installation
+------------
+
+After unzipping the package call:
+
+ $ latex cs-techrep.ins
+
+This will be extract some files (cs-techrep.cls, cs-techrepNLS.sty...). Create a
+directory beneath your TeX installation preferably create
+
+ tex/latex/cs-techrep
+
+and copy all files of the package and the extracted files to that directory.
+
+Call:
+
+ mktexlsr
+
+
+Templates
+---------
+
+In the template directory you can find an example document.
+
+
+Source Code
+-----------
+
+The source code of this latex package can be found at:
+https://github.com/cyberlytics/cs-techrep
+
+The build that creates the CTAN-conforming upload ZIP archive
+can be achieved with the Docker image at Dockerhub:
+cyberlytics/ctan-prep:latest
+
+An examplery 'make dist' call is:
+docker run --rm -it -v ${PWD}/:/app cyberlytics/ctan-prep:latest make dist
+
+The source code of this supportive Docker image can be found at:
+https://github.com/cyberlytics/ctan-prep
+
+
+/Christoph P. Neumann, <cyberpetaneuron+cstechrep@gmail.com>