[README] update

This commit is contained in:
Gaspard Jankowiak 2025-12-15 09:11:10 +01:00
commit 83a32d4fa0

View file

@ -17,15 +17,26 @@ typship download -n local https://imsc.uni-graz.at/git/gjankowiak/typst-exam/
```bash ```bash
mkdir -p ~/.local/share/typst/packages/local/exam mkdir -p ~/.local/share/typst/packages/local/exam
cd ~/.local/share/typst/packages/local/exam cd ~/.local/share/typst/packages/local/exam
curl https://imsc.uni-graz.at/git/gjankowiak/typst-exam/archive/v0.1.0.tar.gz | tar zx --xform 's/typst-exam/0.1.0/' curl https://imsc.uni-graz.at/git/gjankowiak/typst-exam/archive/v0.2.0.tar.gz | tar zx --xform 's/typst-exam/0.2.0/'
``` ```
## Quickstart (CLI)
This will create an `exam` directory in the current directory,
containing the example below.
```sh
typst init @local/exam:0.2.0 exam
```
Tested typst version: `0.14.0`.
## Usage ## Usage
Writing an exam is now easy (see [API](#api) for all options): Writing an exam is now easy (see [API](#api) for all options):
```typ ```typ
#import "@local/exam:0.1.0": exam, exercise, exercise-items, mtext #import "@local/exam:0.2.0": exam, exercise, exercise-items, mtext, horiz-only
#show: exam.with( #show: exam.with(
title: "Exam", title: "Exam",
@ -82,7 +93,7 @@ Let $f : (0, +infinity) → (0, +infinity)$ with $f (x) = e^(-x)$.
Consider the following truthtable: Consider the following truthtable:
#align(center, table( #align(center, table(
stroke: frame(0.5pt), stroke: horiz-only(0.5pt),
columns: (auto, auto, auto), columns: (auto, auto, auto),
align: center, align: center,
[$A$], [$B$], [$A or B$], [$A$], [$B$], [$A or B$],