Skip to content

Commit

Permalink
Add instructions to install glossarium locally
Browse files Browse the repository at this point in the history
  • Loading branch information
quachpas committed Dec 20, 2024
1 parent a98aaef commit e88f8ec
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ To use **glossarium** as a vendored module, download the package files into your
#import "glossarium.typ": make-glossary, register-glossary, print-glossary, gls, glspl
```

To use **glossarium** locally, create a new package namespace on your system:
- follows the instructions at [typst/packages](https://github.com/typst/packages?tab=readme-ov-file#local-packages)
- import glossarium (if your namespace is named `local`):
```typ
#import "@local/glossarium:0.5.1": make-glossary, register-glossary, print-glossary, gls, glspl
```

## Making the glossary

After importing the package and before making any calls to `gls`, ` print-glossary` or `glspl`, please ***MAKE SURE*** you add this line
Expand Down

0 comments on commit e88f8ec

Please sign in to comment.