fix bug + improve readme

This commit is contained in:
Maximilian Keßler 2022-02-16 11:24:04 +01:00
parent f2dfab5a45
commit 4a6689e977
2 changed files with 19 additions and 3 deletions

View file

@ -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

View file

@ -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