From 4a6689e977213409ea0c677bfa8f2cc09a1f42a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Wed, 16 Feb 2022 11:24:04 +0100 Subject: [PATCH] fix bug + improve readme --- README.md | 19 +++++++++++++++++-- init.sh | 3 ++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4271719..b715645 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,23 @@ Finally, do not forget to enable GitLab pages for your project. Go to `Settings Refer to the [GitLab pages documentation][gl pages] for full details on how this works. -If you have not done so yet, refer to the next section to set up a GitLab runner. +If you have not done so yet, refer to [setting up ci](README.md#Setting up GitLab CI) section to set up a GitLab runner. -# Setting up GitLab CI (only needed once) +# Example +An example project generated with the configuration + +``` +#!/bin/bash + +mainfile='2022_Example_Course' +course='Example Course' +stylefile='example' +repo='https://latex-ci.gitlab.io/examples/gitlab-ci-example' +term='summer term 2022' +``` +is available (without any further modification) as [gitlab-ci-example][gitlab-ci-example]. + +# Setting up GitLab CI Refer to the [GitLab Runners Documentation][runnerdoc] for full details on how GitLab runners work. If you want to set up one yourself, for LaTeX projects, the author recommends the following: ### Set up docker container for compilation @@ -91,3 +105,4 @@ You will also have to provide the name of the docker container you intend to run [aergus]: https://gitlab.com/aergus/dockerfiles [kesslermaximilian]: https://github.com/kesslermaximilian/dockerfiles [gl pages]: https://docs.gitlab.com/ee/user/project/pages/ +[gitlab-ci-example]: https://gitlab.com/latexci/examples/gitlab-ci-example diff --git a/init.sh b/init.sh index 41bff2a..45af7b5 100755 --- a/init.sh +++ b/init.sh @@ -25,7 +25,8 @@ rm README.md rm -rf .git # move template files into this directory -mv "template/"* . +mv "template/*" . +mv "template/.*" . mv mainfile.tex $mainfile.tex mv stylefile.sty $stylefile.sty