X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=README.md;h=75ba171048ec935c4b1f00513b8b1cdb72aff69e;hb=3252f096f07575ed1e50a11021ee794b79ad99c7;hp=c40f19e5ef460b746260daad2e3286ff4c4c1721;hpb=4831badeb4ae06f5be0974ce2da855889833736e;p=openjpeg.git diff --git a/README.md b/README.md index c40f19e5..75ba1710 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # OPENJPEG Library and Applications -## What is OpenJPEG ? +## What is OpenJPEG ? OpenJPEG is an open-source JPEG 2000 codec written in C language. It has been developed in order to promote the use of [JPEG 2000](http://www.jpeg.org/jpeg2000), a still-image compression standard from the Joint Photographic Experts Group ([JPEG](http://www.jpeg.org)). Since April 2015, it is officially recognized by ISO/IEC and ITU-T as a [JPEG 2000 Reference Software](http://www.itu.int/rec/T-REC-T.804-201504-I!Amd2). @@ -29,18 +29,12 @@ The library is developed and maintained by the Image and Signal Processing Group * src * lib * openjp2: contains the sources of the openjp2 library (Part 1 & 2) - * openjpwl: contains the additional sources if you want to build a JPWL-flavoured library. * openjpip: complete client-server architecture for remote browsing of jpeg 2000 images. - * openjp3d: JP3D implementation - * openmj2: MJ2 implementation * bin: contains all applications that use the openjpeg library * common: common files to all applications * jp2: a basic codec - * mj2: motion jpeg 2000 executables * jpip: OpenJPIP applications (server and dec server) * java: a Java client viewer for JPIP - * jp3d: JP3D applications - * tcltk: a test tool for JP3D * wx * OPJViewer: gui for displaying j2k files (based on wxWidget) * wrapping @@ -49,15 +43,24 @@ The library is developed and maintained by the Image and Signal Processing Group * doc: doxygen documentation setup file and man pages * tests: configuration files and utilities for the openjpeg test suite. All test images are located in [openjpeg-data](https://github.com/uclouvain/openjpeg-data) repository. * cmake: cmake related files +* scripts: scripts for developers See [LICENSE][link-license] for license and copyright information. -See [INSTALL](https://github.com/uclouvain/openjpeg/blob/master/INSTALL) for installation procedures. +See [INSTALL](https://github.com/uclouvain/openjpeg/blob/master/INSTALL.md) for installation procedures. -See [NEWS](https://github.com/uclouvain/openjpeg/blob/master/NEWS) for user visible changes in successive releases. +See [NEWS](https://github.com/uclouvain/openjpeg/blob/master/NEWS.md) for user visible changes in successive releases. + +## Deprecated components + +The openjpwl, openjp3d and openmj2 components have been removed after the +2.4.0 release. Their building and working state is unknown. People interested +in them should start from the 2.4.0 tag. ## API/ABI +An API/ABI timeline is automatically updated [here][link-api-timeline]. + OpenJPEG strives to provide a stable API/ABI for your applications. As such it only exposes a limited subset of its functions. It uses a mechanism of exporting/hiding functions. If you are unsure which functions you can use in @@ -69,11 +72,12 @@ On windows, MSVC directly supports export/hiding function and as such the only API available is the one supported by OpenJPEG. [comment-license]: https://img.shields.io/github/license/uclouvain/openjpeg.svg "https://img.shields.io/badge/license-BSD--2--Clause-blue.svg" -[badge-license]: https://img.shields.io/badge/license-BSD--2--Clause-blue.svg "BSD 2-clause "Simplified" License" -[link-license]: https://github.com/uclouvain/openjpeg/blob/master/LICENSE "BSD 2-clause "Simplified" License" -[badge-build]: https://travis-ci.org/uclouvain/openjpeg.svg?branch=master "Build Status" -[link-build]: https://travis-ci.org/uclouvain/openjpeg "Build Status" +[badge-license]: https://img.shields.io/badge/license-BSD--2--Clause-blue.svg "BSD 2-clause \"Simplified\" License" +[link-license]: https://github.com/uclouvain/openjpeg/blob/master/LICENSE "BSD 2-clause \"Simplified\" License" +[badge-build]: https://github.com/uclouvain/openjpeg/actions/workflows/build.yml/badge.svg "Build Status" +[link-build]: https://github.com/uclouvain/openjpeg/actions/workflows/build.yml "Build Status" [badge-msvc-build]: https://ci.appveyor.com/api/projects/status/github/uclouvain/openjpeg?branch=master&svg=true "Windows Build Status" [link-msvc-build]: https://ci.appveyor.com/project/detonin/openjpeg/branch/master "Windows Build Status" [badge-coverity]: https://scan.coverity.com/projects/6383/badge.svg "Coverity Scan Build Status" [link-coverity]: https://scan.coverity.com/projects/uclouvain-openjpeg "Coverity Scan Build Status" +[link-api-timeline]: http://www.openjpeg.org/abi-check/timeline/openjpeg "OpenJPEG API/ABI timeline"