aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 025db1a..c31033c 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,16 @@ 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**.
+The default paper size is A4; this can be changed to Letter using `letterpaper` in the options of the class.
+
+Packages `geometry`, `fancyhdr` and `titlesec` are required. All other packages need to be loaded at the preamble of your document.
+
+## 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.
-The default paper size is A4; this can be changed to Letter using `letterpaper` in the options of the class.
-
-Packages `geometry`, `inputenc`, `fancyhdr` and `titlesec` are required. Also, UTF-8 needs to be the encoding of the `.tex` file.
+The `problem` environment is available to put a problem (or anything you want) inside a box.
-The AMS packages need to be loaded in the preamble of the document.