From 9ee0eac55238d69b1925fb2694a1486640f402f6 Mon Sep 17 00:00:00 2001 From: Dominik Becker Date: Tue, 19 May 2020 20:12:02 +0000 Subject: [PATCH] #38 added information on Docker image and markdown workflow to README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d977db1..cd99ca8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # LaTex Boilerplate This is a simple preconfigured boilerplate for medium-sized LaTex projects including continuous integration for GitLab CI. It's based on the `scrbook` document class and currently layed out for german scientiefic documents. +Furthermore, it provides the possibility to write documents in Markdown instead of LaTex. + ## Getting Started To use this template in a new project, either download the [ZIP](https://gitlab.com/fastexitlane/latex-boilerplate/-/archive/master/latex-boilerplate-master.zip) directly from GitLab or clone it using Git: @@ -26,4 +28,8 @@ git remote remove boilerplate In order to use the preconfigured continuous integration, make sure your GitLab CI meets the [Basic Requirements](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/GitLab-CI#basic-requirements). If you know what you're doing, simply start adding your content files in `chapter/` as LaTex `\chapter`s and `\input` them into `main.tex`. -If you do not know what you're doing or get into trouble, you may want to consider the [wiki](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/home) ;-) +If you do not know what you're doing or get into trouble - or want to use the **Markdown Workflow**, you may want to consider the [wiki](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/home) ;-) + + +## Docker Image +If you need a docker image to build your documents, head over to [pandoc-latex](https://github.com/fastexitlane/pandoc-latex) ([DockerHub](https://hub.docker.com/r/fastexitlane/pandoc-latex) \ No newline at end of file