summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/skdoc/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/skdoc/README')
-rw-r--r--macros/latex/contrib/skdoc/README38
1 files changed, 38 insertions, 0 deletions
diff --git a/macros/latex/contrib/skdoc/README b/macros/latex/contrib/skdoc/README
new file mode 100644
index 0000000000..ffa816f402
--- /dev/null
+++ b/macros/latex/contrib/skdoc/README
@@ -0,0 +1,38 @@
+%% skdoc documentation class
+%%
+%% Copyright (C) 2012-2018 by Simon Sigurdhsson <sigurdhsson@gmail.com>
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% 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.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Simon Sigurdhsson.
+%%
+%% This work consists of the files skdoc.dtx
+%% and the derived filebase skdoc.cls.
+
+This is version 1.5a of the skdoc document class. It is designed to
+generate both documentation and derivative files using only LaTeX,
+i.e. without using docstrip and ins/dtx files.
+
+The following files are enclosed.
+
+ README - This file
+ Makefile - GNU Makefile for making the package and documentation
+ skdoc.dtx - LaTeX source code of the package
+ skdoc.pdf - PDF version of the documentation
+
+Installation notes:
+The easiest way to install this package, assuming you have obtained the
+source code from Github or CTAN, is to simply run `make install`. This
+will generate package code and documentation, install it into TEXMFHOME
+and run `mktexlsr`. If you wish to compile the package but not install
+it, run `make all` instead. If you insist on doing it manually, remember
+to run `tex` to generate the code, and `pdflatex` (or `latex`, if you
+don't fancy PDFs) to generate the documentation.