Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Slyde-R committed Oct 3, 2024
1 parent 06822c4 commit ee9bb46
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions packages/preview/not-JKU-thesis/0.1.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

[The compiled demo thesis.pdf](./template/thesis.pdf)

# jku-thesis
This is a Typst template for a thesis at JKU.

## Usage
You can use this template in the Typst web app by clicking "Start from template" on the dashboard and searching for `not-JKU-thesis`.

Alternatively, you can use the CLI to kick this project off using the command
```
typst init @preview/jku-thesis
```

Typst will create a new directory with all the files needed to get you started.

## Configuration
This template exports the `jku-thesis` function with the following named arguments:

- `thesis-type`: String
- `degree`: String
- `program`: String
- `supervisor`: String
- `advisor`: Array of Strings
- `department`: String
- `author`: String
- `date`: datetime
- `place_of_submission`: string
- `title`: String
- `abstract_en`: Content block
- `abstract_de`: optional: Content block or none
- `acknowledgements`: optional: Content block or none
- `showTitleInHeader`: Boolean
- `draft`: Boolean

The template will initialize your package with a sample call to the `jku-thesis` function.

The dummy thesis, including the sources, was created by generative AI and is simply meant as a placeholder. The content, citations, and data presented are not based on actual research or verified information. They are intended for illustrative purposes only and should not be considered accurate, reliable, or suitable for any academic, professional, or research use. Any resemblance to real persons, living or dead, or actual research, is purely coincidental. Users are advised to replace all placeholder content with genuine, verified data and references before using this material in any formal or academic context.


0 comments on commit ee9bb46

Please sign in to comment.