commit: 7e03fa125fbc6b64d60f8349f092f1c946b5936f
parent 96762d349b9d26763161ddd74cd511b18b442189
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Tue, 14 Nov 2023 09:10:34 +0100
README: Add "Design differences" section
Diffstat:
1 file changed, 4 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -6,6 +6,10 @@ This is a repository of my own implementations of commonly available Unix system
Tested on Linux(musl), FreeBSD, NetBSD, OpenBSD: <https://builds.sr.ht/~lanodan/utils-std>
+## Design differences
+- All programs prefix their messages with their name. This way you don't end up with context-less messages in scripts.
+- When the output is structured data, a terminal gets human-oriented output, others like piped programs get machine-oriented output (line separation, CSV, JSON, …). Prior art: most `ls(1)` implementations, i3/sway, FreeBSD utils via `libxo`, …
+
## Goals
- (long-run) Effectively serve as one of the blocks to replace BusyBox, GNU coreutils, …
- Code readability and hackability