diff --git a/README.md b/README.md index 5cc9ea9..db2d458 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ Also see: * The [github wiki](https://github.com/intel/isa-l/wiki) including a list of [distros/ports](https://github.com/intel/isa-l/wiki/Ports--Repos) offering binary packages as well as a list of [language bindings](https://github.com/intel/isa-l/wiki/Language-Bindings). -* ISA-L [mailing list](https://lists.01.org/hyperkitty/list/isal@lists.01.org/). * [Contributing](CONTRIBUTING.md). * [Security Policy](SECURITY.md). +* Docs on [units](doc/functions.md), [tests](doc/test.md), or [build details](doc/build.md). Building ISA-L -------------- @@ -38,7 +38,7 @@ Building ISA-L x86_64: * Assembler: nasm. Version 2.15 or later suggested (other versions of nasm and - yasm may build but with limited function [support.](doc/build.md) + yasm may build but with limited function [support](doc/build.md)). * Compiler: gcc, clang, icc or VC compiler. aarch64: diff --git a/doc/functions.md b/doc/functions.md index de30745..0029b71 100644 --- a/doc/functions.md +++ b/doc/functions.md @@ -109,7 +109,8 @@ CRC functions have a simple interface such as in [crc example]. ~~~ Updates with new buffers are possible with subsequent calls. No extra finalize -step is necessary. +step is necessary. An example of combining independent CRC values is found in +[crc combine example]. ### Compress/Inflate Functions @@ -198,4 +199,5 @@ Examples: [ec example]: https://github.com/intel/isa-l/blob/master/examples/ec/ec_simple_example.c [raid example]: https://github.com/intel/isa-l/blob/master/raid/xor_example.c [crc example]: https://github.com/intel/isa-l/blob/master/crc/crc64_example.c +[crc combine example]: https://github.com/intel/isa-l/blob/master/examples/crc/crc_combine_example.c [igzip example]: https://github.com/intel/isa-l/blob/master/igzip/igzip_example.c