commit 69e85bfdb6a04ac6d69be8a7282cc5ae0806d00c
parent 272fb88c2e690f6e970e107bac932ce25b168e6a
Author: Pavel Renev <an2qzavok@gmail.com>
Date: Sat, 28 Aug 2021 22:31:48 +0000
add README
Diffstat:
1 file changed, 16 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,16 @@
+Richterm is a textual interface that supports different fonts, links,
+images and customizable menu.
+
+Processes can interact with it either by writing/reading to /dev/cons,
+as usual, or by working with its file system, mounted over at
+/mnt/richterm:
+
+Reading from /new file will return id of freshly created element.
+
+/ctl will return events, such as menu hits or link follows, and will
+accept commands to 'clear' the screen or 'remove $id ...'.
+
+Lines written to menu file will appear in the right-click menu.
+
+Directory /$id/ will contain files representing element's properties
+(text, link, image, font).