uni-ausarbeitung/README.md

# Uni Ausarbeitung
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.

Origin: [LaTeX Boilerplate](https://gitlab.com/fastexitlane/latex-boilerplate)


## Getting Started
To use this template in a new project, either download the [ZIP](https://git.kingofdog.de/KingOfDog/uni-ausarbeitung/archive/main.zip) directly from Gitea or clone it using Git:

```bash
git clone git@direct.kingofdog.de:KingOfDog/uni-ausarbeitung.git <directory-name>
# now set up your own Git workspace:
git remote remove origin
git remote add origin git@direct.kingofdog.de:path/to/repo.git
git push origin main
```

If you already have set up an empty Git workspace for your project, add it as additional remote and then fetch and pull:

```bash
git remote add boilerplate git@direct.kingofdog.de:KingOfDog/uni-ausarbeitung.git
git fetch boilerplate
git pull boilerplate main
# if you don't want to keep the remote for pulling future updates, remove it:
git remote remove boilerplate
```

In order to setup the repo for CI / CD on GitLab, Drone CLI on Gitea, Workflos on GitHub and Azure DevOps, as well as VS Code integration, run `setup.sh latex` or `setup.sh markdown`, depending in which workflow you want to use.
CI will use Dockerized builds by default.

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`.
You can then run the build using VS Code preconfigured tasks or using `build.sh`. 

For Markdown, add your content as `*.md` files in `chapter/` and prefix them with ascending numbers (to keep chapter sequence).
You shouldn't need to `\input` or configure anything else, as the files are concatenated automatically at build time.
Run `build.sh pandoc` to build your PDF.

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)).
Also, there's a prebuilt Docker image for spellchecking using Hunspell - head over to [docker-hunspell](https://github.com/fastexitlane/docker-hunspell).