From 4ec3a39c8e77b6fa5e6a1c3d247bc6aa73e1476e Mon Sep 17 00:00:00 2001 From: KingOfDog Date: Wed, 8 Sep 2021 05:35:06 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a1b837..16581c2 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,20 @@ git pull boilerplate main 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. +### 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`. 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). 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.