From ea57c703003a179402f8ad91576ddc7f0eb3cb2f Mon Sep 17 00:00:00 2001 From: Greg Shuflin Date: Tue, 4 Jul 2023 00:49:00 -0700 Subject: [PATCH] Update README --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6b877c9..efad2b2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # Leipzig Glossing in Typst -[Typst](https://github.com/typst/typst) library for creating interlinear -morpheme-by-morpheme glosses according to the [Leipzig glossing -rules](https://www.eva.mpg.de/lingua/pdf/Glossing-Rules.pdf). +`leipzig-glossing` is a [Typst](https://github.com/typst/typst) library for +creating interlinear morpheme-by-morpheme glosses according to the [Leipzig +glossing rules](https://www.eva.mpg.de/lingua/pdf/Glossing-Rules.pdf). -Run `just build-example` to generate a pdf file with examples and documentation. +Run `typst compile leipzig-gloss-examples.typ` in the root of the repository to +generate a pdf file with examples and documentation. This command is also +codified in the accompanying [justfile](https://github.com/casey/just) as `just +build-example`. # License