summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChloe M <chloe@faracom.org>2026-08-19 21:57:09 -0500
committerChloe M <chloe@faracom.org>2026-08-19 21:59:01 -0500
commit8abbda9c2ce05ae41b55be23861603ea2e240d5e (patch)
tree3774a315ece2990de0fa5d6c9b8890c0dff451ec /README
parent278681dece47b018f190aa634cc7e5ae467c514a (diff)
docs: Make README plain text file
Signed-off-by: Chloe M <chloe@faracom.org>
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..886e7b0
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+-- RDAR --
+
+RDAR stands for Reduced Disk Archive Format and serves to be a minimal bundle format (similar to tar)
+for various applications, primarily operating system initial ramdisks. RDAR does not intend to
+replace existing formats and instead aims to provide a potential alternative to them for
+minimalists.
+
+-- BUILDING --
+
+To build, you'll need bop. This can be found at https://aptel.org/bop/
+
+-- FORMAT --
+
+The format is simple:
+
+ 0: root [points to root data region (rdr)]
+ /
+ /
+0~ [DATA DESCRIPTOR] ---------+ OFFSET
+1~ [DATA DESCRIPTOR] -------- |---+ OFFSET
+2~ [FILE] <------------------+ |
+3~ [FILE] <----------------------+