aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Portales-Oliva <f.portales.oliva@gmail.com>2019-04-18 02:11:49 -0400
committerFelipe Portales-Oliva <f.portales.oliva@gmail.com>2019-04-18 02:11:49 -0400
commit16519ca9e66092eeadf1355ba502e5e74275521b (patch)
treee6958a92439a76c95525a83c5cc7924c86ab8728
parent025c0152db35e980250dc95ffa6a61578901ae3b (diff)
modified README to include latest changes in the documentation
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index c31033c..59ddd72 100644
--- a/README.md
+++ b/README.md
@@ -10,10 +10,12 @@ Packages `geometry`, `fancyhdr` and `titlesec` are required. All other packages
## Features available
-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.
+Commands added that **can** to be used in the preamble are:
+- `\institute{}` indicates the institution the homework this is going to be turned in to,
+- `\professor{}` to indicate the name of the professor,
+- `\class{}` to indicate the course this homework is intended to be delivered.
+
+You **have** to provide a title, author and due date trough the `\title{}`, `\author{}` and `\date{}` commands respectively. There is no point in using this class if you don't, therefore the author recommends that if this is the case, you search for something else :(
The `problem` environment is available to put a problem (or anything you want) inside a box.