From 2bd6aa54d61c68285c36d13bb70ec9d59e2c6cab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hildeberto=20Mendon=C3=A7a?= Date: Sat, 13 Jun 2015 15:23:02 +0200 Subject: [PATCH 1/4] Update and rename README to README.md --- README => README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) rename README => README.md (95%) diff --git a/README b/README.md similarity index 95% rename from README rename to README.md index 0a891782..28ee31b8 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 From c255e0140c38c70f95a5d4094775db8e556c8a5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hildeberto=20Mendon=C3=A7a?= Date: Sat, 13 Jun 2015 15:24:45 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 15 +++++++-------- 1 file 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 From dbb67194b2a51a599e3a00edb4d4af031c093442 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hildeberto=20Mendon=C3=A7a?= Date: Sat, 13 Jun 2015 15:33:37 +0200 Subject: [PATCH 3/4] Formatted the readme file Put the extension `md` to allow GitHub to identify the file and transform it to HTML, improving the presentation of the project. Formatted the file to markdown. Put links to references. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56993045..cbfeb1c5 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,11 @@ * 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. + +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 From 79b079bdc0565892e8721eb2cf15f0b746f131d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hildeberto=20Mendon=C3=A7a?= Date: Sat, 13 Jun 2015 15:39:03 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cbfeb1c5..71610954 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# OPENJPEG LIBRARY and APPLICATIONS +# OPENJPEG Library and Applications ## Details on folders hierarchy