First commit

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 41 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1e3a412
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+NAME
+	sumart - Visualise a checksum
+
+SYNOPSIS
+	sumart [rows columns] [checksum]
+
+DESCRIPTION
+	The sumart utility creates a visualisation of a checksum
+	using symbols and colours in a grid.
+
+	If no checksum is specified, it is read from the standard
+	input.
+
+	Any symbol that is not a hexadecimal digit is silently
+	discarded from the checksum.
+
+OPTIONS
+	The sumart utility conforms to the Base Definitions volume of
+	POSIX.1-2024, Section 12.2, Utility Syntax Guidelines.
+
+	No options are supported.
+
+OPERANDS
+	The following operands are supported:
+
+	rows
+		The number of rows tall the visualisation should be.
+
+	colums
+		The number of columns wide the visualisation should be.
+
+	checksum
+		The checksum to visualise.
+
+EXIT STATUS
+	0      Successful completion.
+
+	1      An error occurred.
+
+SEE ALSO
+	None.