KingOfDog/uni-ausarbeitung
Template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
KingOfDog 2021-05-16 20:09:09 +00:00
parent 2e703347d6
commit 8a5343230b
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,33 +1,34 @@
# LaTex Boilerplate
# 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://gitlab.com/fastexitlane/latex-boilerplate/-/archive/master/latex-boilerplate-master.zip) directly from GitLab or clone it using Git:
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@gitlab.com:fastexitlane/latex-boilerplate.git
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@your-own-gitlab.host:path/to/repo.git
git push origin master
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@gitlab.com:fastexitlane/latex-boilerplate.git
git remote add boilerplate git@direct.kingofdog.de:KingOfDog/uni-ausarbeitung.git
git fetch boilerplate
git pull boilerplate master
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 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.
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 want to use the workflow on GitLab, but with own hardware, make sure your GitLab CI meets the [Basic Requirements](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/GitLab-CI#basic-requirements).
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`.