From 0d57e04eae1d7e035d9ce21ef5a8bbe93b51c8df Mon Sep 17 00:00:00 2001 From: Dominik Becker Date: Sun, 19 Aug 2018 17:14:25 +0000 Subject: [PATCH] #17 docs for dockerized CI [skip CI] --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index be17018..e59a4eb 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,9 @@ The `scrbook` document class provides the following elements (in said order) to ## Continuous Integration using GitLab CI The `.gitlab-ci.yml` file comes preconfigured to spellcheck and compile the LaTex document. +You can use it directly on gitlab.com without a private GitLab instance or runner, because the CI jobs rely on corresponding Docker images ([tmaier/hunspell](https://hub.docker.com/r/tmaier/hunspell/) for spellchecking and [bnord01/docker-latex-pygments](https://hub.docker.com/r/bnord01/docker-latex-pygments/) for the actual latex build). + +If you plan to use this boilerplate on your private GitLab instance or to customize it, please keep the following aspects in mind. ### Basic Requirements If you want to use the preconfigured CI scripts, you need to register a shell runner which basically has the following tools installed: