Add readme and makefile

install:

	cp -rp ornltm $(shell kpsewhich -var-value=TEXMFHOME)/tex/latex/

.PHONY: install

# ORNL Technical Memo LaTeX template

This is a completely overhauled version of the official template available at

the [ORNL branding

page](https://portal09.ornl.gov/sites/cm/branding/sitepages/technical-reports.aspx).

Unlike that template, the `ornltm` class is meant to separate the document

styling from your document's content. You should almost be able to replace the

`\documentclass{ornltm}` line in your file with

`\documentclass{elsarticle}` and submit it as a journal article.

## Example

To build the LaTeX example, simply:

```console

$ cd example

$ make

```

This uses [an advanced Makefile](http://www.bouncingchairs.net/oss) to build

the document, but you can of course just run

```console

$ pdflatex ornl-template-example

$ bibtex ornl-template-example

$ pdflatex ornl-template-example

```

to get the main document and references. Some of the advanced features like

acronyms, sorted bibliographies, and indexes require extra commands which the

Makefile can do automatically and will not be described here.

## Installation

Once you have cloned this repository, you should install the `ornltm` package.

The very primitive Makefile at the root of this repository has a good chance of

working:

```console

$ make install

cp -rp ornltm /Users/s3j/Library/texmf/tex/latex/

```

at which point your LaTeX distribution should be able to find the class file.

To verify this, make sure that `kpsewhich` can find the ornltm class.

```console

$ kpsewhich ornltm.cls

/Users/s3j/Library/texmf/tex/latex/ornltm/ornltm.cls

```

## Documentation

The documentation essentially consists of the

[example](./example/ornl-template-example.tex). To build the example,

## Limitations

- The table of contents titles are not uppercase like in the Microsoft Word

  template.

- The full set of document restrictions (OUO etc.) is not available in this

  template. If you add a `\restrict{Official use only}` command to your

  document's header, it will replace the "distribution is unlimited" text box

  with the "Official use only", but this does not fully conform to the official

  template. Since I anticipate that only a small fraction of tech memo users

  will need this capability I didn't make it a priority. Contributions are of

  course welcome.

## Contributions

To contribute to this LaTeX class, simply follow the standard open source guidelines. Create an account on the

[ORNL GitLab page](https://code.ornl.gov/), fork the [ornltm

repository](https://code.ornl.gov/s3j/ornltm), push a branch to your

repository, and create a pull request.

onlysources.tex	?= ornl-template-example.tex

BINARY_TARGET_DIR := $(CURDIR)/out

# These next two lines should only be necessary if you haven't installed the package

_saved_TEXINPUTS := ${TEXINPUTS}

export TEXINPUTS ?= .:$(CURDIR)/../ornltm:$(_saved_TEXINPUTS)