meowsum.git

commit 33f3df1d440392ff5f5c07c1e91c9616fb3b99b5

Author: Adam <git@apiote.tk>

add readme

 README.asciidoc | 45 +++++++++++++++++++++++++++++++++++++++++++++


diff --git a/README.asciidoc b/README.asciidoc
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..fe08d5d287c88aaa3d264d309f0d019b609f76cf 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -0,0 +1,45 @@
+= meowsum
+
+== NAME
+
+meowsum — print or check Meow hash checksums
+
+== SYNOPSIS
+
+meowsum [-ceq] [FILE]...
+
+meowsum [-s size] [FILE]...
+
+== DESCRIPTION
+
+The meowsum utility calculates and prints or checks Meow hash checksums.
+The output format is consistent with POSIX cksum; meowsum prints the checksum,
+number of bytes, and file path to standard output.
+
+When FILE is -, meowsum reads standard input.
+
+== OPTIONS
+
+	-c           read sums from the FILEs and check them
+	-s size      set hash size; size can be 32, 64, 128 bits;
+	             the default is 128
+	
+	The following options are useful only when verifying checksums:
+	-q           only return status; do not print OK, ERH, ERS, ERM
+	-e           fail for missing files
+
+== AUTHORS
+
+Maintained by Adam Pioterek <me@apiote.tk>. Up-to-date sources can be found at
+https://git.apiote.tk/meowsum.git and bugs/patches can be submitted by email to
+git+meowsum@apiote.tk.
+
+== COPYRIGHT
+
+Copyright © 2021 Adam Pioterek. License https://gnu.org/licenses/gpl.html[GPLv3+: GNU GPL version 3 or later].
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+== SEE ALSO
+
+https://github.com/cmuratori/meow_hash[Source code of Meow hash]