From 28fef478d7813eda40aa304baa33f07981002010 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 9 Feb 2013 10:28:13 +0100 Subject: use markdown on readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 40 ---------------------------------------- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 40 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 41413f2..0000000 --- a/README +++ /dev/null @@ -1,40 +0,0 @@ -COMPLETE STATUS: - Pure Java 1.2+ :: optimised - Python 3 :: optimised - C ISO C90 :: optimised - Java/C JNI :: under development - NASM :: planned (maybe, after jni) - Haskell :: planned (maybe) - Python 2 :: planned (maybe) - Perl :: planned (maybe) - Common Lisp :: planned (perhaps) - Scala :: planned (perhaps) - - -SHA-3/Keccak checksum calculator - -USAGE: sha3sum [option...] < FILE - sha3sum [option...] file... - -OPTIONS: - -r BITRATE - --bitrate The bitrate to use for SHA-3. (default: 576) - - -c CAPACITY - --capacity The capacity to use for SHA-3. (default: 1024) - - -w WORDSIZE - --wordsize The word size to use for SHA-3. (default: 64) - - -o OUTPUTSIZE - --outputsize The output size to use for SHA-3. (default: 512) - - -s STATESIZE - --statesize The state size to use for SHA-3. (default: 1600) - - -i ITERATIONS - --iterations The number of hash iterations to run. (default: 1) - - -b - --binary Print the checksum in binary, rather than hexadecimal. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..10e29c1 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +COMPLETE STATUS: + + Pure Java 1.2+ :: optimised + Python 3 :: optimised + C ISO C90 :: optimised + Java/C JNI :: under development + NASM :: planned (maybe, after jni) + Haskell :: planned (maybe) + Python 2 :: planned (maybe) + Perl :: planned (maybe) + Common Lisp :: planned (perhaps) + Scala :: planned (perhaps) + + +**SHA-3/Keccak checksum calculator** + +*USAGE:* + + sha3sum [option...] < FILE + sha3sum [option...] file... + +*OPTIONS:* + + -r BITRATE + --bitrate The bitrate to use for SHA-3. (default: 576) + + -c CAPACITY + --capacity The capacity to use for SHA-3. (default: 1024) + + -w WORDSIZE + --wordsize The word size to use for SHA-3. (default: 64) + + -o OUTPUTSIZE + --outputsize The output size to use for SHA-3. (default: 512) + + -s STATESIZE + --statesize The state size to use for SHA-3. (default: 1600) + + -i ITERATIONS + --iterations The number of hash iterations to run. (default: 1) + + -b + --binary Print the checksum in binary, rather than hexadecimal. + -- cgit v1.2.3-70-g09d2