From 8abbda9c2ce05ae41b55be23861603ea2e240d5e Mon Sep 17 00:00:00 2001 From: Chloe M Date: Wed, 19 Aug 2026 21:57:09 -0500 Subject: docs: Make README plain text file Signed-off-by: Chloe M --- README | 22 ++++++++++++++++++++++ README.md | 21 --------------------- 2 files changed, 22 insertions(+), 21 deletions(-) create mode 100644 README delete mode 100644 README.md 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] <----------------------+ diff --git a/README.md b/README.md deleted file mode 100644 index 4a1151d..0000000 --- a/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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 - -Install ![bop](https://git.faracom.org/chloe/bop) and run ``BOP_BUILD=core bop build`` - -## 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] <----------------------+ -``` -- cgit v1.2.3