madeinshinea/isc-report

A typst template for reports in the ISC @ HEI curricula

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

ISC report template 📜

This is a template for students reports for the ISC degree programme at the School of engineering in Sion.

Install and setup

Using this template requires the typst runtime which can be installed following the instructions from https://github.com/typst/typst

You can also use the online editor from https://typst.app as the template can be used there as well but then you're on your own.

Installing fonts

This report template uses several fonts packaged in this repository. All those fonts are distributed under the SIL Open Font License which is included in this repository.

To the install the fonts in a Linux environment, simply type

source install_fonts.sh

from within the fonts directory.

PDF images inclusion

Unfortunately, typst does not support PDF file types inclusion. As a temporary workaround, PDF files can be converted to SVG via pdf2svg.

Usage

After modifying report.typ, creating a PDF is straighforward with the command

typst compile report.typ

Another nice possibility is of course to use a VScod[e | ium] via the Typst LSP plugin which enables direct compilation.

Future changes

In the future, several things might be updated, such as :

• Acronyms inclusion
• Glossary inclusion
• Master thesis changes for the template
• Themes for code
• Other nice things

Questions and help

If you need any help for installing or running those tools, do not hesitate to get in touch with its maintainer pmudry.

You can of course also propose changes using PR or raise issues if something is not clear. Have fun writing reports!