Initial repo setup

Author: robertjndw

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/workflows/build-release.yml

@@ -0,0 +1,47 @@
+name: Build and release evaluation report
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  build_release_thesis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+          lfs: true
+
+      - name: Create initial tag
+        run: |
+          if [ -z "$(git tag -l 'v*')" ]; then
+            git tag v0.0.0
+          fi
+
+      - name: Bump version and push tag
+        id: bump
+        uses: anothrNick/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+          DEFAULT_BUMP: 'patch'
+
+      - uses: typst-community/setup-typst@v3
+      - run: typst compile main.typ report.pdf
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.bump.outputs.new_tag }}
+          name: Version ${{ steps.bump.outputs.new_tag }}
+          draft: false
+          prerelease: false
+          files: |
+            report.pdf

README.md

@@ -1 +1,65 @@
-# evaluation-report-template-typst
+# Evaluation Report Template (Typst)
+
+This repository contains a template for generating evaluation reports using Typst. The template is designed to be customizable and easy to use for creating professional-looking documents.
+
+## Features
+
+- Customizable title, authors, advisors, and other metadata
+- Automatic generation of sections for strengths, weaknesses, and summary
+- Localization support for German and English
+- Automated build and release process using GitHub Actions
+
+## Installation
+
+For detailed installation instructions, please refer to the [official installation guide](https://github.com/typst/typst). Here, we provide basic steps for installing Typst's CLI:
+
+- You can get sources and pre-built binaries from the [releases page](https://github.com/typst/typst/releases).
+- Use package managers like `brew` or `pacman` to install Typst. Be aware that the versions in the package managers might lag behind the latest release.
+- If you have a [Rust](https://rustup.rs/) toolchain installed, you can also install the latest development version.
+
+Nix and Docker users, please refer to the official installation guide for detailed instructions.
+
+### Getting Started
+
+1. Clone the repository:
+```sh
+git clone https://github.com/yourusername/evaluation-report-template-typst.git
+cd evaluation-report-template-typst
+```
+
+2. Customize the [`main.typ`](./main.typ) file with your report details:
+```typ
+#import "template.typ": *
+#show: gutachten.with(
+  title: "Your Report Title",
+  authors: ("Author One", "Author Two"),
+  advisors: ("Advisor Name",),
+  type: "Bachelor Thesis",
+  date: datetime(day: 1, month: 1, year: 2025),
+  lang: "en",
+  grade_suggestion: 1.7,
+)
+= Themenstellung & Ziele
+#lorem(100)
+
+= Stärken der Arbeit
+#lorem(200)
+
+= Schwächen der Arbeit
+#lorem(200)
+
+= Zusammenfassung
+#lorem(100)
+```
+
+3. Compile the report
+```sh
+typst compile main.typ report.pdf
+```
+
+---
+## Further Resources
+
+- [Typst Documentation](https://typst.app/docs/)
+- [Typst Guide for LaTeX Users](https://typst.app/docs/guides/guide-for-latex-users/)
+- [Typst VS Code Extension (inofficial)](https://marketplace.visualstudio.com/items?itemName=nvarner.typst-lsp)

main.typ

@@ -0,0 +1,23 @@
+#import "template.typ": *
+
+#show: gutachten.with(
+  title: "Es war ein sehr cooles Thema",
+  authors: ("Max Mustermann", "Erika Musterfrau"),
+  advisors: ("Prof. Stephan Krusche",),
+  type: "Bachelorarbeit",
+  date: datetime(day: 1, month: 1, year: 2025),
+  grade_suggestion: 1.7,
+  lang: "de",
+)
+
+= Themenstellung & Ziele
+#lorem(100)
+
+= Stärken der Arbeit
+#lorem(200)
+
+= Schwächen der Arbeit
+#lorem(200)
+
+= Zusammenfassung
+#lorem(100)

template.typ

@@ -0,0 +1,86 @@
+#import "@preview/oxifmt:0.2.1": strfmt
+
+#let i18n_title = (de: "Gutachten", en: "Review Report")
+#let i18n_topic = (de: "Thema", en: "Topic")
+#let i18n_worked_on = (de: "Bearbeitet von", en: "Worked on by")
+#let i18n_supervised_by = (de: "Betreut von", en: "Supervised by")
+#let i18n_handin_date = (de: "Abgabedatum", en: "Hand-in date")
+
+#let i18n_time_date = (de: "Ort und Datum", en: "Time and Date")
+#let i18n_grade_suggestions = (de: "Notenvorschlag", en: "Grade Suggestions")
+
+#let gutachten(
+  title: "", 
+  type: "Bachelorarbeit",
+  authors: (), 
+  advisors: (), 
+  date: datetime.today(),
+  grade_suggestion: 4.0,
+  lang: "de",
+  body
+) = {
+// Set the document's basic properties.
+set document(
+  author: advisors, 
+  title: title,
+  keywords: (i18n_title.at(lang))
+)
+
+// Adjust the page's general layout
+set page(
+  numbering: "1", 
+  number-align: center,
+  header: [
+    #set text(size: 14pt, lang: "de")
+    #h(1fr)
+    #strong(i18n_title.at(lang) + " " + type)
+    #h(1fr)
+  ]
+)
+
+set text(font: "New Computer Modern", size: 10pt, lang: lang)
+set par(justify: true)
+
+// Set the document's headings.
+set heading(numbering: "A)")
+show heading: set text(size: 12pt)
+
+// Indent the document's lists and enumerations a little bit more
+set enum(numbering: "1)", indent: 1em)
+set list(indent: 2em)
+
+{
+  // make the table appear a little bit bigger than the rest of the text
+  set text(size: 12pt)
+  line(length: 100%, stroke: (thickness: 1pt, dash: "dashed"))
+
+  grid(
+    columns: 2,
+    gutter: 1em,
+    align: left,
+    [#strong(i18n_topic.at(lang) + ":")],[#title],
+    [#strong(i18n_worked_on.at(lang) + ":")],[#authors.join(", ")],
+    [#strong(i18n_supervised_by.at(lang) + ":")],[#advisors.join(", ")],
+    [#strong(i18n_handin_date.at(lang) + ":")],[#date.display("[day].[month].[year]")]
+
+  )
+
+  line(length: 100%, stroke: (thickness: 1pt, dash: "dashed"))
+}
+
+body
+
+v(1cm)
+
+stack(
+  dir: ltr,
+  stack(
+    dir: ttb,
+    spacing: 0.5em,
+    strong(i18n_time_date.at(lang)),
+    "Garching, " + datetime.today().display("[day].[month].[year]")
+  ),
+  h(1fr),
+  strong(i18n_grade_suggestions.at(lang) +": " + strfmt("{:.1}", grade_suggestion))
+)
+}