modified README to better describe the document

This commit is contained in:
Felipe Portales-Oliva 2019-03-28 21:11:18 -03:00
parent 125c1fb0cf
commit 3f0282d106

View file

@ -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.