Skip to content

Commit

Permalink
Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
krestenlaust committed Jan 30, 2024
1 parent 640ffbc commit 509ea66
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
# AAU Typst Template
The widely used AAU LaTeX report template, rewritten in Typst
The widely used AAU LaTeX report template, rewritten in Typst.

## Upload to Typst.app
## Template Overview
This project contains the following templates:

- `Report template`

This is the general template, it contains good examples of how to use Typst for common tasks.

- `Report template (empty)` (based on `Report template`)

This is an empty version of the report template. It doesn't contain examples, only filled with lorem ipsum.

- `Singlepage Template` (based on `Report template`)

This template shows how to use the template without 'complicated' folder structure.


### Where to get the templates
The templates are generated for each commit, and every release. You can get the latest 'stable'-template on [releases page](https://github.com/krestenlaust/AAU-Typst-Template/releases).

Every release and commit also contains artifacts with compiled versions (PDFs) to show how they're going to look.

### Using a template with [Typst.app](https://typst.app/)
If you've just barely convinced your group to make use of Typst, then using the web app is probably ideal. It will be familar to Overleaf users, as it resembles a lot, just without all the UI clutter.

#### This shows how to import the `Report template`:
![](docs/TypstUploadDemonstration.gif)

Typst.app doesn't currently support dragging folders, therefore the folders should be created manually, and files dragged in accordingly. **Folder name casing is important.**

## Project Structure
This is an overview of the folders/files in the root of this repository:

Expand All @@ -20,7 +46,9 @@ The main template file. This file is located in `report-template` (and a copy is
This file uses the graphics located in `AAUgraphics`.

## Inspiration
This project replicates the (semi-official) AAU report template located at [jkjaer/aauLatexTemplates](https://github.com/jkjaer/aauLatexTemplates)
This project replicates the (semi-official) AAU report template located at [jkjaer/aauLatexTemplates](https://github.com/jkjaer/aauLatexTemplates).

If you still insist on using LaTeX, then my good friend, Tosuma, has improved the AAU LaTeX template considerately: [Tosuma/AAU-Latex-Template-English](https://github.com/Tosuma/AAU-Latex-Template-English).

## Contribution
Any contribution is welcome!

0 comments on commit 509ea66

Please sign in to comment.