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
+```