# README

This is the README file for the .

## Summary

## Normal installation

This is distributed as a `.tds.zip` file (TDS is the &TeX; Directory Structure, the standard layout for a modern &TeX; installation). Install it on any personal TDS-compliant &TeX; system by unzipping it into your personal &TeX; directory (folder). This will put all the files into the right places, so you can start using them immediately.

If you haven't yet created a personal &TeX; directory, see below for details of what one is, and how to create it.

On a shared (multiuser) system like a server, unzip it into the `$TEXMFLOCAL` directory instead (see below), and run your &TeX; directory-indexing program (eg texhash, mktexlsr, Update FNDB, etc) so that everyone can use it.

If you are using an old non-TDS-compliant system, see below under Manual Installation.

### Your personal &TeX; directory

This is a directory (folder) on single-user systems like desktops and laptops where you put all your local manual modifications, updates, and additions such as classes, packages, and fonts. The name and location are fixed:

Apple Mac OS X

  ~/Library/texmf

Unix and GNU/Linux

  ~/texmf

MS-Windows 95/XP

  C:\texmf

MS-Windows 2007 and above

  Computer\System\YOURNAME\texmf

Create that folder if it does not already exist.

If you are a Windows user running MiK&TeX;

When you create the folder, you must add it to MiK&TeX;'s list of supported folders. Run the MiK&TeX; Maintenance/Settings program, select the Roots tab, and add the folder. You only have to do this once.

Each time you add or remove software in your personal &TeX; folder, you must also click on the Update FNDB button in the General tab.

Unix (Mac and GNU/Linux) users do not need to (indeed, should not) run their filename database indexer (mktexlsr or texhash) for files put in your personal &TeX; directory.

### Installation on shared systems

On multi-user systems (Unix-based), identify the shared local directory tree with the command

    kpsewhich -expand-var '$TEXMFLOCAL'

This will give you the location of the shared `texmf` directory into which you must install these files.

Do not forget to run the texhash or mktexlsr (filename indexer) program after installation, otherwise the files will not be found by &LaTeX; and nothing will work!

## Manual installation (non-TDS systems)

To install this software manually, unzip the zip file into a temporary directory and move the `.` file from the `tex/latex/` directory to a location (directory/folder) where &LaTeX; will find it on your system. This referred to in some documentation as the `TEXINPUTS` directory, although it may be called something else on your system.

It is your responsibility to know where this location is. See the question in the &TeX; FAQ at http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf for more information. If you do not know, or cannot find it, or do not have access to it, your &TeX; system may be out of date need replacing.

### Last resort

In an emergency, and as a last resort on unmanageable systems, it is possible simply to put the `.` file in your current working directory (the same folder as your `.tex` file[s]).

While this may work, it is not supported, and may lead to other resources (packages, fonts, etc) not being found.

## Usage

Make this the first line of your &LaTeX; document:

    \documentclass[options]{}

    \usepackage[options]{}

Read the documentation for the options available. The documentation is distributed as a PDF document in the zip file. You can also regenerate it by typesetting the `.dtx` file with &LaTeX; (and &BiBTeX; and makeindex) in the normal way.

## Bugs and TODO

No outstanding reported bugs at the time of this version.

## Copyright

The following statement is included in the source code: