aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-25 18:29:38 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-25 18:29:38 +0100
commit975299801c06e72fca8d0ff7fbf933d48569b302 (patch)
tree3446ef5c5effb4138c6f6de7476ea7d1d535bca9 /README.md
parent53ab99152433970943381b121a19359ffeee7650 (diff)
update readme + package manifestHEAD1.2.0masterdev
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 6 insertions, 16 deletions
diff --git a/README.md b/README.md
index 8bc6bfa..eee3ba0 100644
--- a/README.md
+++ b/README.md
@@ -2,28 +2,18 @@
Typeset LaTeX compiler logos in [typst](https://github.com/typst/typst).
-## todo
-
-- document `metalogo()` command
-- write a manual
-- fix TODOs
-- check everything for packaging
-
## usage
-From [./demo.typ](./demo.typ):
+From [demo.typ](./demo.typ):
```typ
-#import "@preview/metalogo:1.1.0": TeX, LaTeX, XeLaTeX, XeTeX, LuaLaTeX
-
-#LaTeX is a typestting program based on #TeX. Some people use #XeLaTeX
-(sometimes #XeTeX), or #LuaLaTeX to typeset their documents.
+#import "@preview/metalogo:1.2.0": TeX, LaTeX
-People who are afraid of #LaTeX and its complex macro system may use typst
-instead.
+#LaTeX is a typesetting system based on #TeX.
```
+![](./demo.svg)
-Output:
+All commands and configuration options are documented in [the manual][man].
-![](./demo.svg)
+[man]: https://github.com/lonkaars/typst-metalogo/releases/download/1.2.0/manual.pdf