simplify, reword

This commit is contained in:
Connor Olding 2012-08-04 05:16:03 -07:00
parent b4ed7b4372
commit 11cb3dc92e
1 changed files with 18 additions and 25 deletions

View File

@ -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.