From 1d8a61e401604d6f7e6d75fd47a04c6c654f2791 Mon Sep 17 00:00:00 2001 From: Michael Kohlhase Date: Thu, 21 Jan 2016 18:54:57 +0100 Subject: [PATCH] better formatting and more tuned to github --- README.md | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3fa7664..f53e281 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,18 @@ -LaTeX-proposal +LaTeX-proposal: A set of LaTeX classes for preparing proposals for collaborative projects ============== -proposal.cls: A set of LaTeX classes for preparing proposals for collaborative projects -The base proposal class supports many of the general elemenst of project proposals. It is -optimized towards collaborate projects. This class is intended to be specialized to -particular funding bodies that have their own styles. +The base proposal class supports many of the general elements of project proposals. It is +optimized towards collaborating on writing project proposals. This class is intended to be +specialized to particular funding bodies that have their own styles. -MANIFEST: -base: the base proposal class -dfg: the instance for Deutsche Forschungsgemeinschaft -eu: the instance for EU proposals -etc: style files from the sTeX bundle added for convenience - (only on GitHub, not on CTAN) -lib: Makefiles for the management of self-documenting packages -bin: A script that makes GitHub issues from the deliverables of a - proposal for project managment if the proposal is granted. +==MANIFEST== +* ```base```: the base proposal class ([documentation](tree/master/base/proposal.pdf)) +* ```dfg```: the instance for Deutsche Forschungsgemeinschaft ([documentation](tree/master/dfg/dfgproposal.pdf), [examples](tree/master/dfg/examples)) +* ```eu```: the instance for EU proposals ([documentation](tree/master/eu/euproposal.pdf), [examples](tree/master/eu/examples)) +* ```etc```: style files from the sTeX bundle added for convenience (only on GitHub, not on CTAN) +* ```lib```: Makefiles for the management of self-documenting packages +* ```bin```: utilities, e.g. a script that makes GitHub issues from the deliverables of a proposal for project managment if the proposal is granted. Copyright(c) 2010 Michael Kohlhase The package is distributed under the terms of the LaTeX Project Public License (LPPL) -The development version of this package can be found at -https://github.com/KWARC/LaTeX-proposal -This also contains examples and Makefiles that help the proposal writing process.