summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHildeberto Mendonça <htmfilho@users.noreply.github.com>2015-06-13 15:24:45 +0200
committerHildeberto Mendonça <htmfilho@users.noreply.github.com>2015-06-13 15:24:45 +0200
commitc255e0140c38c70f95a5d4094775db8e556c8a5e (patch)
treecfff024d42d91e920f5f6f86cb57c04a8c0d0fe1 /README.md
parent2bd6aa54d61c68285c36d13bb70ec9d59e2c6cab (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/README.md b/README.md
index 28ee31b8..56993045 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# OPENJPEG LIBRARY and APPLICATIONS
-## Details on folders hierarchy:
+## Details on folders hierarchy
* src
* lib
@@ -27,19 +27,18 @@
* 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 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.
-----------------
-API/ABI
+## 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