summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/grant/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/grant/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/grant/README.md')
-rw-r--r--macros/latex/contrib/grant/README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/macros/latex/contrib/grant/README.md b/macros/latex/contrib/grant/README.md
new file mode 100644
index 0000000000..514326d949
--- /dev/null
+++ b/macros/latex/contrib/grant/README.md
@@ -0,0 +1,62 @@
+[![CTAN package](https://img.shields.io/badge/ctan-latest-orange.svg)](https://www.ctan.org/pkg/grant)
+[![Documentation](https://readthedocs.org/projects/gdoc-down/badge/?version=latest)](https://github.com/KarrLab/latex-grant)
+[![License](https://img.shields.io/github/license/KarrLab/latex-grant.svg)](LICENSE)
+
+# latex-grant
+
+LaTeX classes for formatting scientific documents, including grant proposals.
+* `grants`: Base class for formatting grant proposals
+* `grant-arl`: Army Research Laboratory
+* `grant-darpa`: Defense Advanced Research Projects Agency
+* `grant-doe`: Department of Energy
+* `grant-nih`: National Institutes of Health
+* `grant-nrl`: Naval Research Laboratory
+* `grant-nsf`: National Science Foundation
+* `grant-onr`: Office of Naval Research
+
+## Installation
+
+### Tex Live/MikTeX
+The package is available through TeX Live and MikTeX as `grant`.
+
+### Manual install
+
+1. Compile the LaTeX classes
+
+ ```
+ cd /path/to/repo
+ cd grant
+ latex grant.ins
+ mkdir -p /path/to/repo/tex/latex/grant/
+ mv *.cls /path/to/repo/tex/latex/grant/
+ ```
+2. Add `/path/to/repo` to your list of LaTeX root directories
+
+## Example usage
+```
+\documentclass{grant-nsf}
+
+\addbibresource{Bibliography.bib}
+
+\begin{document}
+
+\chapter{Project-Summary}
+...
+
+\chapter{Project-Description}
+...
+
+\chapter{Bibliography \& References Cited}
+\printbibliography[heading=none]
+
+\end{document}
+```
+
+## License
+The example model is released under the [MIT license](LICENSE).
+
+## Development team
+`latex-grant` was developed by [Jonathan Karr](http://www.karrlab.org) at the Icahn School of Medicine at Mount Sinai in New York, USA.
+
+## Questions and comments
+Please contact the [Jonathan Karr](http://www.karrlab.org) with any questions or comments.