aboutsummaryrefslogtreecommitdiff
path: root/lib/typst/README.md
diff options
context:
space:
mode:
authorAnhgelus Morhtuuzh <william@herges.fr>2026-04-29 22:30:04 +0200
committerAnhgelus Morhtuuzh <william@herges.fr>2026-04-29 22:30:04 +0200
commit78f399521661c82e45e627bbbdc8ce4daa9e5207 (patch)
tree2671aa93feb01956aded5cef1e725f9aff4aa3a9 /lib/typst/README.md
parent77ccdd8559383c25fc59fbcba38117102e5657b5 (diff)
style(typst): move in lib folder
Diffstat (limited to 'lib/typst/README.md')
-rw-r--r--lib/typst/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/typst/README.md b/lib/typst/README.md
new file mode 100644
index 0000000..6e2530f
--- /dev/null
+++ b/lib/typst/README.md
@@ -0,0 +1,12 @@
+# typst library
+
+This folder contains a Rust library used to compile typdown's typst components.
+We cannot write it in Zig, because there are no existing C bindings for typst.
+
+## Build example
+
+```shell
+$ cargo build
+$ gcc example.c -o example -ltypdown_typst -L./target/debug
+$ LD_LIBRARY_PATH=./target/debug ./example
+```