From eacc8add5ddbd1a68a1dea6a70666a0b97e1b227 Mon Sep 17 00:00:00 2001
From: Christian Krause <christian.krause@idiv.de>
Date: Wed, 5 Jun 2019 14:07:56 +0200
Subject: [PATCH] adds alternatives section
---
README.md | 41 +++++++++++++++++++++++++++++------------
1 file changed, 29 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 93b9a98..b29d206 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-Change to Document Title Here
-=============================
+Pandoc Template
+===============
A flexible and future proof way to write documents.
@@ -29,12 +29,24 @@ The default features include:
### Disabling Features
-You can remove some features just by removing the respective content in the
-Markdown sources.
+You can disable most features by just removing the respective content in the
+Markdown sources. Some feature are integrated in the `Makefile` for which you
+need to perform additional steps:
- **plots:** remove the `*.R` file(s) in `img/plot`
- **flowcharts:** remove the `*.dot` file(s) in `img/graph`
+### Alternatives
+
+Most features and tools are optional **and** replaceable, the only real core
+tool is [pandoc][]. Besides that, everything can be changed, e.g. you could use
+a different programming language for plotting, you could use [Inkscape][] to
+create and edit your flowcharts, or you could even use a different build tool.
+
+If you have an idea, suggestion, or even a concrete example, feel free to [open
+an issue][issue] or create a merge request. The more (optional) features we can
+offer the more it shows how flexible and future proof this way of working is.
+
Continuous Integration
----------------------
@@ -58,9 +70,10 @@ integrated. See [this issue][spell-check-issue] for more information and
progress.
If you think that the spell checker with its [current
-limitations][spell-check-issue] is more of an annoyance than help, you can
-disable it by removing the **check** stage from the `.gitlab-ci.yml` file. Once
-the issues are fixed, you can simply re-enable it by reverting the commit.
+limitations][spell-check-issue] is more of an annoyance than help and you can
+rely on the spell checking from your editor, you can disable it by removing the
+**check** stage from the `.gitlab-ci.yml` file. Once the issues are fixed, you
+can simply re-enable it by [reverting the commit][git-revert].
### Deployment to Nextcloud
@@ -131,8 +144,8 @@ build the template PDF, you need these dependencies:
- [pandoc and pandoc-citeproc][pandoc]
- LaTeX, either through **texlive** or **MiKTeX**
- GNU **make**
-- [graphviz][]
-- R including the packages **data.table**, **tidyverse** and **svglite**
+- [Graphviz][]
+- [R][] including the packages **data.table**, **tidyverse** and **svglite**
`install.packages(c("data.table", "tidyverse", "svglite"), Ncpus = 8)`
- [watchexec][]
- [markdown-spellcheck][]
@@ -140,12 +153,16 @@ build the template PDF, you need these dependencies:
**Note:** On MS Windows, it might be helpful using [chocolatey][].
-[idiv-nc]: https://portal.idiv.de/nextcloud/
-[spell-check-issue]: https://git.idiv.de/templates/pandoc/issues/3
[chocolatey]: https://chocolatey.org/
[git]: https://git-scm.com/downloads
-[graphviz]: https://graphviz.gitlab.io/download/
+[git-revert]: https://git-scm.com/docs/git-revert
+[Graphviz]: http://www.graphviz.org/download/
+[idiv-nc]: https://portal.idiv.de/nextcloud/
+[Inkscape]: https://inkscape.org/
+[issue]: https://git.idiv.de/templates/pandoc/issues/new
[markdown-spellcheck]: https://www.npmjs.com/package/markdown-spellcheck
[pandoc]: https://pandoc.org/installing.html
+[R]: https://www.r-project.org/
+[spell-check-issue]: https://git.idiv.de/templates/pandoc/issues/3
[watchexec]: https://github.com/watchexec/watchexec/releases
--
GitLab