From 6a63d639b549ecb034879bb6151aee73a04183d7 Mon Sep 17 00:00:00 2001
From: "Achim D. Brucker" <adbrucker@0x5f.org>
Date: Mon, 20 Jun 2022 18:51:24 +0100
Subject: [PATCH] Improved documentation.

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index db1cb31..82ce5c4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# EPSRC - A LaTeX Style Implementing the Layout of EPSRC Funding Proposal
+# A LaTeX Style Implementing the Layout of EPSRC Funding Proposals
 
 This LaTeX class provides a layout for EPSRC funding applications in the UK. It
 focuses on the traditional proposal layout, that is summarized on the [EPSRC
@@ -18,11 +18,66 @@ as follows:
 > Also, as Je-S does not support all Microsoft Office Word font types, unsupported
 > fonts will be replaced, possibly resulting in layout changes to the document.
 
-*Warning:* While this class tries to follow this layout as closely as possible,
-there is no guarantee that proposal written using this class are accepted for
+**Disclaimer:** While this class tries to follow this layout as closely as possible,
+there is no guarantee that proposal written using the EPSRC class are accepted for
 review (i.e., not desk rejected) and neither is there a guarantee of a positive
 funding outcome.
 
+## Usage
+
+To ensure the consistency of common configurations across the various documents
+that EPSRC requires, the class file uses a file `epsrc.config` that, if available,
+is shared across all documents. A minimal example is:
+
+```latex
+\author{Poor Researcher}
+\projectitle[PGMM]{Please Give Me Money}
+
+```
+
+Otherwise, the class file is loaded as usual:
+
+```latex
+\documentclass{epsrc}
+```
+
+This ensures a document following the basic layout on a4 paper with 2 cm margins
+and a base font that is metrially compatible with Arial (the current setup uses
+[Arimo](https://fonts.google.com/specimen/Arimo)). Moreover, the font size is
+scaled to use 11 pt in Postscript Points.
+
+### Package Options
+
+The `epsrc` class only has one option, called `hideinfo` that is `false` by
+default. This options configures if additional information using the `\info{}`
+command are shown or now.
+
+### Provided Commands
+
+The provides the following commands:
+
+* `\info{...}` for type-setting informative text for co-authors. In the final
+  submission, this text is usually hidden (using the class option `hideinfo`).
+* `\projectitle[shorttitle]{longtitle}` for setting the project title (and,
+  optional, an acronym).
+* `\project` for printing the full title of a project (long title and acronym)
+* `\projectlong` for printing the long title of a project
+* `\projectshort` for printing the short title of a project
+
+### Bibliography
+
+The package configures `biblatex` for type-setting bibliographies. All standard commands of the package `biblatex` can be used. Moreover, the class file provides
+the following additional commands:
+
+* `\citeapplicant{...}` as a variation of the `\cite{...}`, marking the citation
+  a work of one of the applicants of the proposal. They are marked in the
+  bibliography.
+* `\singlecolprintbibliography` as an alternative to `\printbibliography` with a
+  pre-configured single-column layout (this might be bending the EPSRC rules)
+* `\twocolprintbibliography` as an alternative to `\printbibliography` with a
+  pre-configured two-column layout (this might be bending the EPSRC rules)
+
+
 ## Authors
 
 Main author: [Achim D. Brucker](http://www.brucker.ch/)