From be96a6731e0c077b4e1be0d40a58e14b9238602a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dirk=20Br=C3=B6mmel?= <d.broemmel@fz-juelich.de>
Date: Thu, 5 Aug 2021 07:48:41 +0000
Subject: [PATCH] Update README.md
---
README.md | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 626598e..a3ef970 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,15 @@
# LaTeX class for a PRACE Project Access Applications
-### (c) PRACE aisbl - Partnership for Advanced Computing in Europe
-### authors: Dirk Brömmel - Forschungszentrum Jülich GmbH
-### Florian Berberich - PRACE aisbl
+(c) PRACE aisbl - Partnership for Advanced Computing in Europe
+ authors:
+ Dirk Brömmel - Forschungszentrum Jülich GmbH
+ Florian Berberich - PRACE aisbl
Please report any problems with this template to peer-review@prace-ri.eu.
-The latest version of the required files is available as download:
-[PRACE-Project-Access-Form.tar.gz](https://repository.prace-ri.eu/git/latex-templates/prace-project-access-application/-/jobs/artifacts/master/raw/PRACE-Project-Access-Form.tar.gz?job=build-example).
-[PRACE-Project-Access-Form.zip](https://repository.prace-ri.eu/git/latex-templates/prace-project-access-application/-/jobs/artifacts/master/raw/PRACE-Project-Access-Form.zip?job=build-example).
+The latest version of the required files is available as download:
+* [PRACE-Project-Access-Form.tar.gz](https://repository.prace-ri.eu/git/latex-templates/prace-project-access-application/-/jobs/artifacts/master/raw/PRACE-Project-Access-Form.tar.gz?job=build-example)
+* [PRACE-Project-Access-Form.zip](https://repository.prace-ri.eu/git/latex-templates/prace-project-access-application/-/jobs/artifacts/master/raw/PRACE-Project-Access-Form.zip?job=build-example)
## PURPOSE
Enable the writing of a PRACE Project Access Application.
@@ -18,7 +19,7 @@ Enable the writing of a PRACE Project Access Application.
`template.tex` : PRACE Project Access Application template
`prace-header.jpg` : page header from PRACE (used by prace.cls)
-The `example` directory contains a full example:
+The `example` directory contains an example without hints:
`example.tex` : example of a filled-in template
`example.pdf` : example PRACE Access Application
@@ -35,12 +36,22 @@ The current version of the template is meant for use with `latex` or `pdflatex`,
## MACROS
```tex
-\project{}{}
+\project%
+ {}% % Project name
+ {} % Research field
```
-Sets and displays general information about the project.
+Sets and displays general information about the project, two mandatory arguments.
```tex
-\PI{}{}{}{}{}{}{}
+\PI%
+ {} % PI's Title
+ {} % Last name
+ {} % First name
+ {} % Name of the organisation
+ {} % Name of the department
+ {} % Name of the group
+ {} % Country
+
\CoPI{}{}{}{}{}{}{}
```
-Set and displays information for the project's PI and possible Co-PIs.
+Set and displays information for the project's PI and possible Co-PIs, both having 7 mandatory arguments.
--
GitLab