fixed readme
This commit is contained in:
parent
56a73bb0ba
commit
717fac612f
1 changed files with 18 additions and 8 deletions
24
README.md
24
README.md
|
@ -1,12 +1,13 @@
|
||||||
crc32
|
crc32
|
||||||
-----
|
=====
|
||||||
|
|
||||||
A [crc32][crc] calculator written in C and licensed under GPLv3.
|
A [crc32][crc] calculator written in C and licensed under the [GPLv3 license.][gpl]
|
||||||
|
|
||||||
[crc]: http://en.wikipedia.org/wiki/Cyclic_redundancy_check "cycle redundancy check on wikipedia"
|
[crc]: http://en.wikipedia.org/wiki/Cyclic_redundancy_check
|
||||||
|
[gpl]: http://www.gnu.org/licenses/gpl.txt
|
||||||
|
|
||||||
Compilation
|
Compilation
|
||||||
===========
|
-----------
|
||||||
|
|
||||||
gcc -ansi -pedantic -Wall -Werror -O3 main.c -o crc32
|
gcc -ansi -pedantic -Wall -Werror -O3 main.c -o crc32
|
||||||
|
|
||||||
|
@ -15,12 +16,21 @@ or for Visual Studio users
|
||||||
cl /O2 /Ot /W2 /WX /Fecrc32 main.c
|
cl /O2 /Ot /W2 /WX /Fecrc32 main.c
|
||||||
|
|
||||||
Help
|
Help
|
||||||
====
|
----
|
||||||
|
|
||||||
|
-h, --help display this text
|
||||||
|
-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 for crc calculations (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
|
||||||
|
|
||||||
Notes
|
Notes
|
||||||
=====
|
-----
|
||||||
|
|
||||||
* Defaults to comply to IEEE-802.3 specs.
|
* Does not pad input.
|
||||||
* Big endian calculations may not be accurate. I'll look into this.
|
* Big endian calculations may not be accurate. I'll look into this.
|
||||||
|
|
Loading…
Add table
Reference in a new issue