From f6a09325e29ac7e035fd9e1c6c872618fdd4ec3b Mon Sep 17 00:00:00 2001 From: Kresten Laust Date: Tue, 23 Jan 2024 21:41:48 +0100 Subject: [PATCH] Improved readme --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5e9a963..6287fd6 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,17 @@ The widely used AAU LaTeX report template, rewritten in Typst ## Project Structure This is an overview of the folders/files in the root of this repository: +Each template contains the following: + - `AAUgraphics` -Contains the graphics of the standard report template. +Contains the graphics used in the template. - `main.typ` -This is the source of the demo files. It includes the chapters located in `Chapters`. - - - `Chapters` -This folder contains the chapters of `main.typ`. - - - `main_single_file_demo.typ` -A single-file demo, separate from the multi-file demo: `Chapters`. +This is the main source, it includes any other files, and this file is the sole target for the compiler, if you want to compile locally, run `typst compile main.typ`. - `template.typ` -The main template file. This file is imported in both `main_single_file_demo.typ` and `Chapters/main.typ`. -This file references the graphics situated in `AAUgraphics`. +The main template file. This file is located in `report-template` (and a copy is stored in `singlefile-template`). +This file uses the graphics located in `AAUgraphics`. ## Inspiration