readme

README.md

@@ -15,4 +15,46 @@ additional.tex
 
 Compile it with `LuaLaTeX`, for details see the `Makefile`.
 
-The main file is `poster.tex`, the custom style is defined in `layout/beamerthemeLasNQposter.sty`
\ No newline at end of file
+The main file is `poster.tex`, the custom style is defined in `layout/beamerthemeLasNQposter.sty`
+
+## Make your own
+
+If you want to use one of the templates, the nicest way is to [fork](https://docs.gitlab.com/ee/workflow/forking_workflow.html) the project.
+This way it is possible to update your customized version with the upstream changes made in the template.
+Or if you made changes that are of worth to be submitted in the template you can make a merge request and update the template.
+
+### Merge Changes from the Template
+
+#### Set up Remote
+
+The first time you have to set up your git repository to follow the template:
+
+```bash
+git remote add template https://gitlab.aei.uni-hannover.de/las-nq/templates/
+```
+
+#### Fetch the Changes
+
+Now you can fetch the changes
+```bash
+git fetch template
+```
+checkout the branch you want to merge to
+```bash
+git checkout master
+```
+and merge it.
+```bash
+git merge template/master
+```
+
+That's all. Now you've got the updates and all your changes are still the same.
+
+
+### Merge Request to the Template
+
+If you make changes that should be updated on the template, make a branch for them:
+```bash
+git checkout -b my-new-branch
+```
+After making the changes, committing and pushing them to GitLab you can make a merge request as described in the [GitLab Fork docs](https://docs.gitlab.com/ee/workflow/forking_workflow.html)