summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAntonin Descampe <antonin@gmail.com>2011-04-13 22:38:50 +0000
committerAntonin Descampe <antonin@gmail.com>2011-04-13 22:38:50 +0000
commit6aaaa3eae28d82e3a2c34e0bd57d027be0685869 (patch)
tree1b616558a699117a50d2230744632e82e64bb196 /README
parent16f205d886407d087fbaa5d00ff31e371f97cb51 (diff)
changed the directory hierarchy of the whole project. See README files for details.
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
index 031cf3d8..2ee2b541 100644
--- a/README
+++ b/README
@@ -1 +1,23 @@
+
+OPENJPEG LIBRARY and APPLICATIONS
+----------------------------------
+
+Details on folders hierarchy:
+
+* libopenjpeg: contains the sources of the openjpeg library
+ * jpwl: contains the additional sources if you want to build a JPWL-flavoured library.
+* applications: contains all applications that use the openjpeg library
+ * common: common files to all applications
+ * codec: a basic codec
+ * mj2: motion jpeg 2000 executables
+ * JavaOpenJPEG: java jni to use openjpeg in a java program
+ * indexer_JPIP: obsolete. Will be replaced by a complete JPIP implementation soon.
+ * OPJViewer: gui for displaying j2k files (based on wxWidget)
+* thirdparty: thirdparty libraries used by some applications. These libraries will be build only if there are not found on the system. Note that libopenjpeg itself does not have any dependency.
+* doc: doxygen documentation setup file and man pages
+* testing: all files required to test the library and executables (obsolete)
+* CMake: cmake related files
+* m4: autotools related files
+
+see LICENSE for license and copyright information
see INSTALL for installation procedures. \ No newline at end of file