From 069cbe589640a05fe9eec1cc46d4a33c7c418766 Mon Sep 17 00:00:00 2001
From: architeuthidae <am@m-labs.hk>
Date: Sun, 27 Oct 2024 14:50:40 +0100
Subject: [PATCH] Add README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..203d77b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# sinara-hw/datasheets
+
+Repository for Sinara hardware datasheets.
+
+## Build all
+
+```shell
+nix build .#all-pdfs
+```
+
+Output files will be in `result`.
+
+### Build individual sheets
+
+```shell
+nix develop
+make 1124
+```
+
+Output files will be in `build`. Run make twice in a row to get correct output for all LaTeX features, i.e. in particular correct "page x of y" footnotes, which require two passes of the compiler. (`#all-pdfs` already does this automatically). Auxiliary files and clutter can be removed with `make clean`.
\ No newline at end of file