add readme

README.md

+[![Download PDF](https://img.shields.io/badge/Download-PDF-blue.svg)](https://zwischenbericht.gitlab-pages.dkrz.de/zwischenbericht-template/zwischenbericht.pdf)
+[![Download DOCX](https://img.shields.io/badge/Download-DOCX-green.svg)](https://zwischenbericht.gitlab-pages.dkrz.de/zwischenbericht-template/zwischenbericht.docx)
+
+# Zwischenbericht Template
+
+This repository contains LaTeX documents for Zwischenbericht to archive and versioning the template reports
+
+## Branches
+
+- **main**: Contains the latest report for Zwischenbericht the template project.
+- **template**: Use this branch for writing new documents or making changes to the template.
+
+## Tags
+
+Tags are used to archive seasonal Zwischenbericht of the template project. Each tag corresponds to a specific report version.
+
+## Requirements
+
+- [LaTeX](https://www.latex-project.org/get/)
+- [Pre-commit](https://pre-commit.com/)
+
+## Installation
+
+1. Install LaTeX and ensure it's available in your PATH.
+2. Install pre-commit by running:
+
+    ```bash
+    pip install pre-commit
+    ```
+
+3. Set up pre-commit hooks by running:
+
+    ```bash
+    pre-commit install
+    ```
+
+4. To run pre-commit manually with verbose:
+
+    ```bash
+    pre-commit run --all-files -v
+    ```
+
+## Usage
+
+### Compilation
+
+To compile the LaTeX document, run:
+
+```bash
+make
+```
+
+This will generate the PDF file.
+
+### Cleaning
+
+To remove temporary LaTeX files, run:
+
+```bash
+make clean
+```
+
+### Pre-commit Hooks
+
+This repository is configured with pre-commit hooks to ensure code quality. These hooks will run automatically before each commit.
+
+- `trailing-whitespace`: Removes trailing whitespace from files.
+- `end-of-file-fixer`: Ensures that files end with a newline.
+- `chktex`: Checks for LaTeX syntax errors and potential issues.
+- `compile-latex`: Compiles the LaTeX document to check for compilation errors.
+
+## File Structure
+
+- `src/`: Contains the LaTeX source files.
+- `Makefile`: Automates LaTeX compilation and cleaning.