mirror of
https://git.adityakumar.xyz/fphw.git
synced 2024-09-18 18:53:05 +00:00
modified README to include latest changes in the documentation
This commit is contained in:
parent
025c0152db
commit
16519ca9e6
1 changed files with 6 additions and 4 deletions
10
README.md
10
README.md
|
@ -10,10 +10,12 @@ Packages `geometry`, `fancyhdr` and `titlesec` are required. All other packages
|
||||||
|
|
||||||
## Features available
|
## Features available
|
||||||
|
|
||||||
Commands added that **need** to be used in the preamble are:
|
Commands added that **can** to be used in the preamble are:
|
||||||
- `\institute{args}` indicates the institution the homework this is going to be turned in to,
|
- `\institute{}` indicates the institution the homework this is going to be turned in to,
|
||||||
- `\professor{args}` to indicate the name of the professor,
|
- `\professor{}` to indicate the name of the professor,
|
||||||
- `\class{args}` to indicate the course this homework is intended to be delivered.
|
- `\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.
|
The `problem` environment is available to put a problem (or anything you want) inside a box.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue