Skip to content

Commit

Permalink
* Makefile and Readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
kcbanner committed Apr 16, 2011
1 parent c502283 commit db8a109
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
5 changes: 2 additions & 3 deletions Makefile
Expand Up @@ -21,8 +21,8 @@ PACKAGE = uw-wkrpt

# Use pdfLaTeX for best results
LATEX = pdflatex
LATEX2DVI = $(LATEX) \\pdfoutput=0 \\input
LATEX2PDF = $(LATEX) \\pdfoutput=1 \\input
LATEX2DVI = $(LATEX) --output-format=dvi
LATEX2PDF = $(LATEX) --output-format=pdf

# MakeIndex parameters
MAKEINDEX = makeindex
Expand All @@ -36,7 +36,6 @@ BIBTEX = bibtex
TEXI2DVI = LATEX="$(LATEX2DVI)" texi2dvi -l latex
TEXI2PDF = PDFLATEX="$(LATEX2PDF)" texi2dvi -l latex -p


# Installation
INSTALL = /usr/bin/install -c
INSTALL_DATA = $(INSTALL) -m 644
Expand Down
28 changes: 22 additions & 6 deletions README.md
Expand Up @@ -2,7 +2,7 @@

This is a LaTeX document class to make you life easier when writing work term reports for the University of Waterloo.

This class was originally written by Simon Law, and was available at: http://www.eng.uwaterloo.ca/~sfllaw/programs/uw-wkrpt/. That page no longer exists.
This class was originally written by Simon Law, and was available at: http://www.eng.uwaterloo.ca/~sfllaw/programs/uw-wkrpt/. It is now also available at: http://sfllaw.ca/programs/uw-wkrpt/

I have made some improvements and updates to bring this class more in line with the current work report guidelines. If you notice any issues or inconsistencies with the guidlines, please let me know, or send a pull request!

Expand All @@ -21,19 +21,26 @@ at: http://www.tug.org/begin.html

# Installation

uw-wkrpt now has an installation system. If you are on a Unix-like
system, and have a complete TeX system, find where your texmf root is.
This should typically be /usr/share/texmf which implies that installing
is as easy as running:
To generate the class files, simply run:

# make DESTDIR=/usr/share install
# make

This will generate uw-wkrpt.cls, which you can use to write your work report.

On a Windows system, to generate the cls file:

> latex uw-wkrpt.ins

Note that if you change any of the *.dtx files, the cls will need to be regenerated.


uw-wkrpt now has an installation system. If you are on a Unix-like
system, and have a complete TeX system, find where your texmf root is.
This should typically be /usr/share/texmf which implies that installing
is as easy as running:

# make DESTDIR=/usr/share install

On some systems, PDFTeX is set to output to A4 paper, even
though we have set the default to letterpaper. This is sad, and can be
worked around. If you are running Debian GNU/Linux, you should run
Expand All @@ -48,6 +55,15 @@ lines:
You will want to comment out any other instances of page_width and
page_height by using the % character.

# Examples

There are several examples included:

* uw-wkrpt-cecs.tex
* uw-wkrpt-ece.tex
* uw-wkrpt-math.tex
* uw-wkrpt-se.tex

# Files

* The README.md file is the one you are reading now.
Expand Down

0 comments on commit db8a109

Please sign in to comment.