From 2186de1bd63e4624c99d03d77b95959d7287a6db Mon Sep 17 00:00:00 2001 From: Dominik Becker Date: Sun, 24 May 2020 15:54:53 +0200 Subject: [PATCH] #42 cleaned up MWe and added info to readme --- README.md | 3 ++- chapter/01_test.tex | 2 -- chapter/02_test.md | 2 -- .gitlab-ci.yml => latex.gitlab-ci.yml | 0 4 files changed, 2 insertions(+), 5 deletions(-) delete mode 100644 chapter/01_test.tex delete mode 100644 chapter/02_test.md rename .gitlab-ci.yml => latex.gitlab-ci.yml (100%) diff --git a/README.md b/README.md index d3e2af4..c60bf87 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,12 @@ 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). +Then rename either `latex.gitlab-ci.yml` or `markdown.gitlab-ci.yml` to `.gitlab-ci`, depending on which workflow you want to use. 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 - or want to use the **Markdown Workflow**, you may want to consider the [wiki](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/home) ;-) ## Docker Images -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)). +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)). Also, there's a prebuilt Docker image for spellchecking using Hunspell - head over to [docker-hunspell](https://github.com/fastexitlane/docker-hunspell). \ No newline at end of file diff --git a/chapter/01_test.tex b/chapter/01_test.tex deleted file mode 100644 index 799e9e1..0000000 --- a/chapter/01_test.tex +++ /dev/null @@ -1,2 +0,0 @@ -Hier könnte Ihre Werbuing stehen. -Da war ein Wort falsch. \ No newline at end of file diff --git a/chapter/02_test.md b/chapter/02_test.md deleted file mode 100644 index 799e9e1..0000000 --- a/chapter/02_test.md +++ /dev/null @@ -1,2 +0,0 @@ -Hier könnte Ihre Werbuing stehen. -Da war ein Wort falsch. \ No newline at end of file diff --git a/.gitlab-ci.yml b/latex.gitlab-ci.yml similarity index 100% rename from .gitlab-ci.yml rename to latex.gitlab-ci.yml