docs: Add README.md

Signed-off-by: Chloe M. <chloe@mensia.org>
2026-06-28 01:26:27 +00:00
parent a829418eb0
commit 6424cb799e
1 changed files with 10 additions and 0 deletions
@@ -0,0 +1,10 @@
+# The CUMHOLE initial ramdisk format
+
+Cumhole is a wovely initrd format meant for bundling files into a format in which individual
+files can be extracted by path.
+
+## What makes this different than e.g., TAR?
+
+Unlike TAR, CUMHOLE avoids metadata soup and octal encodings, in addition, we employ an offset table
+at the beginning of each archive [as opposed to the end where data is stored] where the minimal metadata
+lives as well as an offset to per-file data!