diff --git a/README b/README.md similarity index 79% rename from README rename to README.md index 0a8917825..716109549 100644 --- a/README +++ b/README.md @@ -1,8 +1,7 @@ -OPENJPEG LIBRARY and APPLICATIONS ----------------------------------- +# OPENJPEG Library and Applications -Details on folders hierarchy: +## Details on folders hierarchy * src * lib @@ -28,19 +27,19 @@ Details on folders hierarchy: * tests: configuration files and utilities for the openjpeg test suite. All test images are located in 'http://openjpeg.googlecode.com/svn/data' folder. * cmake: cmake related files -see LICENSE for license and copyright information. -see INSTALL for installation procedures. -see NEWS for user visible changes in successive releases. -see CHANGES for per-revision changes. +See [LICENSE](https://github.com/uclouvain/openjpeg/blob/master/LICENSE) for license and copyright information. ----------------- -API/ABI +See [INSTALL](https://github.com/uclouvain/openjpeg/blob/master/INSTALL) for installation procedures. + +See [NEWS](https://github.com/uclouvain/openjpeg/blob/master/NEWS) for user visible changes in successive releases. + +## API/ABI 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 mecanism of exporting/hiding functions. If you are unsure which functions you can use in your applications, you should compile OpenJPEG using something similar to gcc: --fvisibility=hidden compilation flag. +`fvisibility=hidden` compilation flag. See also: http://gcc.gnu.org/wiki/Visibility On windows, MSVC directly supports export/hidding function and as such the only