aboutsummaryrefslogtreecommitdiff
path: root/typst/README.md
diff options
context:
space:
mode:
authorAnhgelus Morhtuuzh <william@herges.fr>2026-04-29 16:14:49 +0200
committerAnhgelus Morhtuuzh <william@herges.fr>2026-04-29 16:14:49 +0200
commit007af47ed42931b887483be6ec95073c198ab07f (patch)
treee626be89b4ea0f61025d6a85ef2d7075b878371e /typst/README.md
parent4551f9c554c1fef32ef2b7e55b01b1fb90186cbf (diff)
feat(typst): extern rust functions for C ABI
Diffstat (limited to 'typst/README.md')
-rw-r--r--typst/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/typst/README.md b/typst/README.md
new file mode 100644
index 0000000..6e2530f
--- /dev/null
+++ b/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
+```