Added Changelog file

This commit is contained in:
lammertb
2016-12-04 13:30:13 +01:00
parent 9ab15e3107
commit 5090d80633
2 changed files with 23 additions and 0 deletions

10
CHANGELOG.md Normal file
View File

@@ -0,0 +1,10 @@
# Change log for libcrc
This document describes the changes between the different versions of the libraries. Please note that no change log is available for versions prior to version 2.0.
## Changes between development version and version 2.0
* Function [`crc_64_ecma()`](doc/crc_64_ecma.md) added
* Function [`crc_64_we()`](doc/crc_64_we.md) added
* Function [`update_crc_64()`](doc/update_crc_64.md) added
* Optimized CRC calculations by removing temporary variables in the loops

View File

@@ -6,12 +6,25 @@ since that time. Recently that code was merged with previously unpublished
developments and that library is now available at [Github](https://github.com/lammertb/libcrc/).
An online version of the CRC calculation routines is also available at [www.lammertbies.nl](https://www.lammertbies.nl/comm/info/crc-calculation.html).
The CRC library with API reference also has a new home at [www.libcrc.org](http://libcrc.org). An
online version of the API documentation is available on this website.
## License
The original version of the source code available on www.lammertbies.nl had no license attached. The
repackaged version on Github is licensed with the MIT license to make the library
useful in open and closed source products independent of their licensing scheme.
## Differences between versions
It is safe to say that in general you should use the latest stable version of the library available
from the [releases page](https://github.com/lammertb/libcrc/releases). In some circumstances it may be
necessary to use an older version or to use the development version instead. The differences between
these versions can be found in the [Changelog](changelog.md) document which is part of the distribution.
Please note that the development version is a snapshot of the ongoing development of the library and that
that version may not be stable and reliable enough for production environments.
## Platforms
Since the first version, the source code has been compiled and used on many platforms ranging from 8 bit micro controllers