From fa3d006db3dbe6609259ca979cd31b51b0d9b396 Mon Sep 17 00:00:00 2001
From: Millian Poquet <millian.poquet@irit.fr>
Date: Tue, 29 Apr 2025 20:33:54 +0200
Subject: [PATCH] ring buffer readme

---
 ring-buffer/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 ring-buffer/README.md

diff --git a/ring-buffer/README.md b/ring-buffer/README.md
new file mode 100644
index 0000000..5f8cef6
--- /dev/null
+++ b/ring-buffer/README.md
@@ -0,0 +1,10 @@
+```sh
+# You need typst 0.13.0, for example by entering this nix shell
+nix shell 'github:nixos/nixpkgs?rev=b41a1c5a563159e05cdef20305aa9278fe38e523#typst' --command zsh
+
+# Generate figure once
+typst compile ring-buffer.typ
+
+# Alternatively, generate the figure every time input files are saved on filesystem
+typst watch ring-buffer.typ
+```
-- 
GitLab