README.md 2.8 KB
Newer Older
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
1
# LaTeX Kick-Start
2

Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
3 4 5 6 7 8 9 10 11
You want to quickly set up your LaTeX-based project such that
* [SSOT (Single Source of Truth)](https://en.wikipedia.org/wiki/Single_source_of_truth) is guaranteed,
* collaborators can seamlessly work together through [git](https://xkcd.com/1597/),
* your product is [continuously delivered](https://en.wikipedia.org/wiki/Continuous_delivery)?

Sounds like you should [*kick-start*](https://dictionary.cambridge.org/dictionary/english/kick-start) your project ASAP.

## Steps to Kick-Start

12
### (I) `Import` this Project into Your TUHH-GitLab Namespace
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

* Log into your TUHH-GitLab account at [`https://collaborating.tuhh.de/users/sign_in`](https://collaborating.tuhh.de/users/sign_in)
* Click on `New Project` or visit [`https://collaborating.tuhh.de/projects/new`](https://collaborating.tuhh.de/projects/new)
* Select the tile **Import project**
* Select **Import project from** `Repo by URL`
* Under **Git repository URL** paste this *Clone with HTTPS*-URL 
```
https://collaborating.tuhh.de/cfg0846/latex-kick-start.git
```
* Set a suitable **Project Name**
* Choose the **Visibility Level** 
* Click on `Create Project`
* Go back to the project dashboard or visit [`https://collaborating.tuhh.de/dashboard/projects`](https://collaborating.tuhh.de/dashboard/projects)
* Select the project you just created

### (II) Activate GitLab Runner 

* Go to `Settings - CI/CD`
* Locate **Runners** and click `Expand`
* Under **Shared runners** click `Enable shared runners`

34
### (III) Add a Badge for Downloading Your Product
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
35 36 37

* Go to `Settings - General`
* Locate **Badges** and click `Expand`
38 39
* Name your badge
* Paste the following URL under **Link**
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
40 41 42
```
https://collaborating.tuhh.de/%{project_path}/-/jobs/artifacts/master/raw/main.pdf?job=build
```
43
* Paste the following URL under **Badge image URL**
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
44 45 46
```
https://img.shields.io/badge/Download-PDF-brightgreen
```
47
* The badge should now appear on your projects main page and look like this one:
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
48

49
![](https://img.shields.io/badge/Download-PDF-brightgreen)
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
50

51
Note that the badge does not point to a product yet but it will, eventually, after you commited a change to this repository. 
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
52

53
#### You just finished kick-starting your project. Enjoy the ride!
Fabian Nuraddin Alexander Gabel's avatar
Fabian Nuraddin Alexander Gabel committed
54 55 56 57 58 59 60


## Credits and Further Resources

* [A Cookbook for LaTeX with git](https://collaborating.tuhh.de/alex/latex-git-cookbook) by Alexander Povel (@alex) -- extensive resource if you want to push your project to the next level.
* [Island of TeX](https://gitlab.com/islandoftex) -- nice repo with further utilities. They also provide the TeX Live [Docker image](https://gitlab.com/islandoftex/images/texlive) that is used by our pipeline.
* [shields.io](https://shields.io/) -- used to create the download badge.
61
* [TeXtidote](https://github.com/sylvainhalle/textidote) -- a correction tool (spelling and grammar) for LaTeX documents and other formats
62