From ea785099bb9af6ccfaffac07821b1dcc2d0e1bb2 Mon Sep 17 00:00:00 2001 From: Felipe Portales-Oliva Date: Sat, 30 Mar 2019 00:41:07 -0300 Subject: updated README to add new inclusions to the package --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'README.md') 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. -- cgit v1.2.3