summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChloe M. <chloe@faracom.org>2026-07-28 00:30:36 -0400
committerChloe M. <chloe@faracom.org>2026-07-28 00:32:04 -0400
commit82bfab9087574c0f2a812c132d02a718c6b53486 (patch)
tree284ba489a6554ef61967f62de019e7d5bbc88354 /README.md
parent4bda74184186dd0e1d4657a0e6ff5c869ff6492c (diff)
docs: Add description of format
Signed-off-by: Chloe M. <chloe@faracom.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a12b73..08c0196 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,17 @@ RDAR does not intend to replace existing formats and instead aims to provide a p
## Building
Simply run ``make`` and that's it !!
+
+## 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] <----------------------+
+```