Revision f911225,
1.3 KB
checked in by Hal Finkel <hfinkel@…>, 10 years ago
(diff) |
Add a README file
|
-
Property mode set to
100644
|
Rev | Line | |
---|
[f911225] | 1 | ** Description ** |
---|
| 2 | |
---|
| 3 | This library implements a high-performance computation of the 64-bit |
---|
| 4 | cyclic-redundancy check (CRC) of arbitrary input data. This implementation |
---|
| 5 | requires only a C99 compiler, but has been tuned for the IBM BG/Q |
---|
| 6 | supercomputer, and can take advantage of a compiler's OpenMP support to compute |
---|
| 7 | the CRC in parallel on multiple cores. |
---|
| 8 | |
---|
| 9 | Computing and storing or transmitting the CRC code of data while it is written |
---|
| 10 | to disk or transmitted over the network, and then using it to verify the |
---|
| 11 | integrity of the data upon read-in or receipt, is a powerful way to guard |
---|
| 12 | against data corruption. While modern disks and networks are highly reliable, |
---|
| 13 | the rate of corruption from malfunctioning software, hardware and external |
---|
| 14 | physical processes remains significant (especially for large data sets). |
---|
| 15 | |
---|
| 16 | ** Building and installing ** |
---|
| 17 | |
---|
| 18 | To use the included Autoconf/Automake-based build system, run: |
---|
| 19 | ./configure [options] |
---|
| 20 | to see a list of command-line options accepted by 'configure', run: |
---|
| 21 | ./configure --help |
---|
| 22 | |
---|
| 23 | Then run: |
---|
| 24 | make |
---|
| 25 | make test |
---|
| 26 | make install |
---|
| 27 | |
---|
| 28 | ** Building from git ** |
---|
| 29 | |
---|
| 30 | If you've retrieved the source code directly from the git repository, then |
---|
| 31 | you'll need to generate the initialize the Autoconf/Automake system prior to |
---|
| 32 | building. Run the following in the top-level directory: |
---|
| 33 | autoreconf --install |
---|
| 34 | |
---|
Note: See
TracBrowser
for help on using the repository browser.