summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/gmutils/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/gmutils/README')
-rw-r--r--Master/texmf-dist/doc/latex/gmutils/README66
1 files changed, 66 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/gmutils/README b/Master/texmf-dist/doc/latex/gmutils/README
new file mode 100644
index 00000000000..5009d110d06
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/gmutils/README
@@ -0,0 +1,66 @@
+The gmutils package
+is a work of Grzegorz `Natror' Murzynowski,
+<natror at o2 dot pl>
+
+
+1. Copyright 2006 by Grzegorz `Natror' Murzynowski
+
+This program is subject to the LaTeX Project Public License.
+See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
+for the details of that license.
+
+
+2. Introduction
+
+The gmutils.sty package provides some macros that are analogous to
+the standard LaTeX ones but extend their functionality, such as
+\@ifnextcat, \addtomacro or \begin(*). The others are just
+conveniences I like to use in all my TeX works, such as \afterfi, \pk
+or \cs.
+
+I wouldn't say they are only for the package writers but I assume
+some nonzero (La)TeX-awareness of the user.
+
+
+3. Installation
+
+Just put the gmutils.sty somewhere in the texmf/tex/latex
+branch. Creating a /texmf/tex/latex/gm directory may be advisable if
+you consider using other packages written by me.
+
+Then you should refresh your TeX distribution's files'
+database most probably.
+
+
+4. Contents
+
+The distribution of this package consists of the following four files.
+
+gmutils.sty
+README
+gmutilsDoc.tex
+gmutilsDoc.pdf
+
+
+5. Documentation
+
+The last of the above files (the .pdf) is a documentation compiled
+from the .sty file by running LaTeX on the gmutilsDoc.tex file twice,
+then MakeIndex on the gmutils.idx file, and then LaTeX
+on gmutilsDoc.tex once more.
+
+MakeIndex shell command:
+ makeindex -r gmutilsDoc
+The -r switch is to forbid MakeIndex make implicit ranges since the
+(code line) numbers will be hyperlinks
+
+Compiling of the documentation requires the packages: gmdoc
+(gmdoc.sty and gmdocc.cls), gmverb.sty, gmutils.sty and also some
+standard packages: hyperref.sty, color.sty, geometry.sty,
+multicol.sty, lmodern.sty, fontenc.sty that should be installed
+on your computer by default.
+
+If you have not installed the mwart.cls class (available on CTAN in
+mwcls package), the result of your compilation may differ a bit from
+the .pdf provided in this .zip archive in formattings: If you have not
+installed mwart.cls, the standard article.cls will be used.