From 3f0282d10696a2f16164b91ddd7d37947d5a9b49 Mon Sep 17 00:00:00 2001 From: Felipe Portales-Oliva Date: Thu, 28 Mar 2019 21:11:18 -0300 Subject: [PATCH] modified README to better describe the document --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f9a11a..be75507 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,10 @@ This is a class dedicated to format your homework. It is designed to be easy to It is heavily based on the standard `article` class and it accepts all the same optional arguments, except for `twoside` and `twocolumn`, which difficult reading of the finished document. An `spanish`option is added to support the use of spanish; **this does not remove the need for the babel package**. -Commands added are: +Commands added that **need** to be used in the preamble are: + +- `\institute{args}` indicates the institution the homework this is going to be turned in to, +- `\professor{args}` to indicate the name of the professor, +- `\class{args}` to indicate the course this homework is intended to be delivered. + +Packages `geometry`, `inputenc`, `fancyhdr` and `titlesec` are required. The AMS packages need to be loaded in the preamble of the document. \ No newline at end of file