aditya/fphw
1
0
Fork 0
mirror of https://git.adityakumar.xyz/fphw.git synced 2024-11-09 14:59:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated README to add new inclusions to the package

Browse source
This commit is contained in:
Felipe Portales-Oliva 2019-03-30 00:41:07 -03:00
parent fbc4d7e6ba
commit ea785099bb
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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**. 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: 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, - `\institute{args}` indicates the institution the homework this is going to be turned in to,
- `\professor{args}` to indicate the name of the professor, - `\professor{args}` to indicate the name of the professor,
- `\class{args}` to indicate the course this homework is intended to be delivered. - `\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. The `problem` environment is available to put a problem (or anything you want) inside a box.
Packages `geometry`, `inputenc`, `fancyhdr` and `titlesec` are required. Also, UTF-8 needs to be the encoding of the `.tex` file.
The AMS packages need to be loaded in the preamble of the document.