From 11cb3dc92eb580c70610df563e637244fa9b1d9d Mon Sep 17 00:00:00 2001 From: Connor Olding Date: Sat, 4 Aug 2012 05:16:03 -0700 Subject: [PATCH] simplify, reword --- README.md | 43 ++++++++++++++++++------------------------- 1 file changed, 18 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e5163bd..6c31efe 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,31 @@ crc32 ===== -A [crc32][crc] calculator written in C and licensed under the [GPLv3.][gpl] +It computes [crc32s,][crc] and what of it? [crc]: http://en.wikipedia.org/wiki/Cyclic_redundancy_check -[gpl]: http://www.gnu.org/licenses/gpl.txt - -Compilation ------------ - - gcc -ansi -pedantic -Wall -Werror -O3 main.c -o crc32 - -or for Visual Studio users - - cl /O2 /Ot /W2 /WX /Fecrc32 main.c Usage ---- - crc32 - 32-bit cyclic redundancy check calculator - - -h, --help display this text - --license show copyright & license information - -i, --input f open file f for reading (default: stdin) - -s, --start-at n start cycle with n (default: 0xFFFFFFFF) - -p, --polynomial n use n as the crc divisor (default: 0x04C11DB7) - -e, --big-endian use big endian calculations (default: little) - -b, --binary output as binary (default: hex with newline) - -x, --xor xor the output by 0xFFFFFFFF - -r, --reflect reverse the bits of the output - - numbers (n) can be entered as hexadecimal or octal with prefixes +``` +crc32 - 32-bit cyclic redundancy check calculator + + -h, --help display this text + --license show copyright & license information + -i, --input f open file f for reading (default: stdin) + -s, --start-at n start cycle with n (default: 0xFFFFFFFF) + -p, --polynomial n use n as the crc divisor (default: 0x04C11DB7) + -e, --big-endian use big endian calculations (default: little) + -b, --binary output as binary (default: hex with newline) + -x, --xor xor the output by 0xFFFFFFFF + -r, --reflect reverse the bits of the output + +numbers (n) may be entered as hexadecimal or octal with prefixes +``` Notes ----- * Does not pad input. -* Big endian calculations may be inaccurate. I'll look into this. +* Big endian calculations are somewhat untested. +