summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/mlacls/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/mlacls/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/mlacls/README.md')
-rw-r--r--macros/latex/contrib/mlacls/README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/macros/latex/contrib/mlacls/README.md b/macros/latex/contrib/mlacls/README.md
new file mode 100644
index 0000000000..c2b200f8f2
--- /dev/null
+++ b/macros/latex/contrib/mlacls/README.md
@@ -0,0 +1,71 @@
+mla.cls
+=======
+
+LaTeX class for MLA papers.
+
+Abstract
+--------
+
+In the United States, secondary and undergraduate students
+are generally expected to adhere to the format prescribed by
+the Modern Language Association (MLA) for typewritten essays,
+research papers and writings.
+Sadly, the tool of choice is usually Microsoft Word,
+even amongst those fluent with TeX.
+
+Though there *are* some templates and tools to aid in writing
+in the MLA format using LaTeX, none fully met the expectations
+of the author.
+So *voilĂ *, there now exists an `mla.cls` proper:
+a simple, straightforward class for composing papers almost
+perfectly adherent to the MLA style guide.
+
+Documentation
+-------------
+
+Documentation and source are combined into a
+[`.dtx` file](https://texfaq.org/FAQ-dtx),
+as is typical for LaTeX packages.
+To read the documentation, run `mla.dtx` through LaTeX:
+```console
+$ pdflatex mla.dtx
+$ gv mla.dtx
+```
+(If you're getting this package from [CTAN](https://ctan.org/pkg/mlacls),
+a file called `mla.pdf` should already be provided.)
+
+For an example file, refer to `mla-example.tex` and `mla-example.bib`,
+or to the appendix in the documentation.
+
+Installation
+------------
+
+Run `mla.ins` through LaTeX:
+```console
+$ latex mla.ins
+```
+Once finished, move the output `mla.cls` to your local
+[`texmf` directory](https://texfaq.org/FAQ-privinst).
+
+Authorship & licensing
+----------------------
+
+`mlacls` copyright 2019 Seth Price (ssterling AT firemail DOT cc).
+Released under the
+[LaTeX Project Public License v1.3c](https://www.latex-project.org/lppl/lppl-1-3c/).
+
+See [`CHANGELOG.md`](./CHANGELOG.md) for version history.
+
+Contributing
+------------
+
+Submit a merge request on the
+[GitLab repository](https://gitlab.com/ssterling/mlacls/).
+I rarely look at the GitHub mirror.
+
+Bugs
+----
+
+Refer to [`BUGS.md`](./BUGS.md).
+Please report any bugs to the
+[issue tracker](https://gitlab.com/ssterling/mlacls/issues).