From: DRC Date: Fri, 23 Mar 2018 05:00:58 +0000 (-0500) Subject: README.md: clarify where API docs can be found X-Git-Tag: 1.5.90~6 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d83c997749355ca66145fb1fe9cb439b5ac2d9a4;p=libjpeg-turbo README.md: clarify where API docs can be found --- diff --git a/README.md b/README.md index 80ba6c1..7671a6c 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,8 @@ JPEG images: transforms on an image. The Java interface for libjpeg-turbo is written on top of the TurboJPEG API. The TurboJPEG API is recommended for first-time users of libjpeg-turbo. Refer to [tjexample.c](tjexample.c) and - [TJExample.java](java/TJExample.java) for examples of its usage. + [TJExample.java](java/TJExample.java) for examples of its usage and to + for API documentation. - **libjpeg API**
This is the de facto industry-standard API for compressing and decompressing @@ -58,7 +59,8 @@ JPEG images: more powerful. The libjpeg API implementation in libjpeg-turbo is both API/ABI-compatible and mathematically compatible with libjpeg v6b. It can also optionally be configured to be API/ABI-compatible with libjpeg v7 and v8 - (see below.) + (see below.) Refer to [cjpeg.c](cjpeg.c) and [djpeg.c](djpeg.c) for examples + of its usage and to [libjpeg.txt](libjpeg.txt) for API documentation. There is no significant performance advantage to either API when both are used to perform similar operations.