Merge pull request #507 from htmfilho/master

Formatted the readme file
This commit is contained in:
Antonin Descampe 2015-06-15 09:56:50 +02:00
commit 0a0cb190da
1 changed files with 9 additions and 10 deletions

View File

@ -1,8 +1,7 @@
OPENJPEG LIBRARY and APPLICATIONS # OPENJPEG Library and Applications
----------------------------------
Details on folders hierarchy: ## Details on folders hierarchy
* src * src
* lib * 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. * 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 * cmake: cmake related files
see LICENSE for license and copyright information. See [LICENSE](https://github.com/uclouvain/openjpeg/blob/master/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 [INSTALL](https://github.com/uclouvain/openjpeg/blob/master/INSTALL) for installation procedures.
API/ABI
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 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 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 exporting/hiding functions. If you are unsure which functions you can use in
your applications, you should compile OpenJPEG using something similar to gcc: 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 See also: http://gcc.gnu.org/wiki/Visibility
On windows, MSVC directly supports export/hidding function and as such the only On windows, MSVC directly supports export/hidding function and as such the only