Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 2.1 KB

README.md

File metadata and controls

65 lines (49 loc) · 2.1 KB
Raw

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. Here, we provide basic steps for installing Typst's CLI:

  • You can get sources and pre-built binaries from the releases page.
  • 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 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:
git clone https://github.com/yourusername/evaluation-report-template-typst.git
cd evaluation-report-template-typst
  1. Customize the main.typ file with your report details:
#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,
)
= Objectives and Goals
#lorem(100)

= Strengths of the Work
#lorem(200)

= Weaknesses of the Work
#lorem(200)

= Summary
#lorem(100)
  1. Compile the report
typst compile main.typ report.pdf

Further Resources