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-09-08 05:35:06 +00:00
parent 231cf2c5c0
commit 4ec3a39c8e
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -27,12 +27,20 @@ git pull boilerplate main
git remote remove boilerplate 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. ### Setup CI/CD
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. CI will use Dockerized builds by default.
### Writing
#### Latex
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`. 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`. You can then run the build using VS Code preconfigured tasks or using `build.sh`.
#### Markdown
For Markdown, add your content as `*.md` files in `chapter/` and prefix them with ascending numbers (to keep chapter sequence). 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. 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. Run `build.sh pandoc` to build your PDF.