From 686dff998ad1d94768a2af954b4fdd6fae863aea Mon Sep 17 00:00:00 2001 From: Dominik Becker Date: Mon, 29 Jun 2020 22:38:51 +0200 Subject: [PATCH] #40 added quick start guide for setup script --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9f090f9..8f21551 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,19 @@ git pull boilerplate master git remote remove boilerplate ``` -In order to use the preconfigured CI / CD pipeline for building PDFs, copy either `latex.gitlab-ci.yml` or `markdown.gitlab-ci.yml` to `.gitlab-ci`, depending on which workflow you want to use. -On GitLab.com, this will use Dockerized builds by default. -If you want to use the workflow on own hardware, make sure your GitLab CI meets the [Basic Requirements](https://gitlab.com/fastexitlane/latex-boilerplate/wikis/GitLab-CI#basic-requirements). +In order to setup the repo for CI / CD on GitLab and Azurre 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`. + +For Markdown, add your content as `*.md` files in `chapter/` and prefix them with ascending numbers. +You shouldn't need to `\input` or configure anything else, as the files are concatenated automatically at build time. + 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). \ No newline at end of file +Also, there's a prebuilt Docker image for spellchecking using Hunspell - head over to [docker-hunspell](https://github.com/fastexitlane/docker-hunspell).