Change build instructions and README to reflect the fact that the Java front-end...

git-svn-id: svn+ssh://svn.code.sf.net/p/libjpeg-turbo/code/trunk@563 632fc199-4ca6-4c93-a231-07263d6284db

diff --git a/BUILDING.txt b/BUILDING.txt
index 86ca1c99dcd7dbd202f07ce42690bcbdeeae0806..133844247d5d397664def2435c9a2fef9c51049f 100644 (file)
--- a/BUILDING.txt
+++ b/BUILDING.txt
@@ -30,12 +30,13 @@ Build Requirements
 
 -- GCC v4.1 or later recommended for best performance
 
--- If building the TurboJPEG/OSS JNI wrapper, jni.h is required.  Some systems,
-   such as OS X 10.4 and Solaris 10, have this header pre-installed.  On OS X
-   10.5 and later, the header can be obtained by installing the Java Developer
-   Package, which can be downloaded from http://connect.apple.com.  On Linux
-   and other systems, the header can be obtained by installing the GCJ
-   (GCC-Java) development packages or the Oracle Java Development Kit (JDK).
+-- If building the TurboJPEG/OSS Java wrapper, JDK or OpenJDK 1.5 or later is
+   required.  Some systems, such as OS X 10.4, Solaris 10 and later, and Red
+   Hat Enterprise Linux 5 and later, have this pre-installed.  On OS X 10.5 and
+   later, it will be necessary to install the Java Developer Package, which can
+   be downloaded from http://connect.apple.com.  For systems that do not have a
+   JDK installed, you can obtain the Oracle Java Development Kit from
+   http://www.java.com.
 
 
 ==================
@@ -124,8 +125,8 @@ add --without-arith-enc or --without-arith-dec to the configure command line to
 disable encoding or decoding (respectively.)
 
 
-TurboJPEG/OSS JNI Wrapper
--------------------------
+TurboJPEG/OSS Java Wrapper
+--------------------------
 Add --with-java to the configure command line to incorporate an optional Java
 Native Interface wrapper into the TurboJPEG/OSS dynamic library and build the
 Java front-end classes to support it.  This allows the TurboJPEG/OSS dynamic
@@ -318,14 +319,8 @@ Build Requirements
 -- NASM (http://www.nasm.us/) 0.98 or later (NASM 2.05 or later is required for
    a 64-bit build)
 
--- If building the TurboJPEG/OSS JNI wrapper, jni.h is required.  This header
-   can be obtained by installing the Oracle Java Development Kit (JDK).
-   * If using Visual C++, then add the appropriate Java include directories
-     (Example:  c:\Program Files\Java\jdk1.6.0_23\include;c:\Program Files\Java\jdk1.6.0_23\include\win32)
-     to the INCLUDE environment variable prior to building libjpeg-turbo.
-   * If using MinGW, then add the appropriate Java include directories
-     (Example:  /c/Program Files/Java/jdk1.6.0_23/include:/c/Program Files/Java/jdk1.6.0_23/include/win32)
-     to the CPATH environment variable prior to building libjpeg-turbo.
+-- If building the TurboJPEG/OSS Java wrapper, JDK 1.5 or later is required.
+   This can be downloaded from http://www.java.com.
 
 
 ==================
@@ -466,12 +461,13 @@ add "-DWITH_ARITH_ENC=0" or "-DWITH_ARITH_DEC=0" to the cmake command line to
 disable encoding or decoding (respectively.)
 
 
-TurboJPEG/OSS JNI Wrapper
--------------------------
-Add "-DWITH_JNI=1" to the cmake command line to incorporate an optional Java
-Native Interface wrapper into the TurboJPEG/OSS dynamic library.  This allows
-the dynamic library to be used directly from Java applications.  See
-java/README for more details.
+TurboJPEG/OSS Java Wrapper
+--------------------------
+Add "-DWITH_JAVA=1" to the cmake command line to incorporate an optional Java
+Native Interface wrapper into the TurboJPEG/OSS dynamic library and build the
+Java front-end classes to support it.  This allows the TurboJPEG/OSS dynamic
+library to be used directly from Java applications.  See java/README for more
+details.
 
 
 ========================

diff --git a/java/README b/java/README
index ebe564e04a896ad46b4dd614457407800fccd664..f5866829cbdb767e4277f197d39999bf15b383ac 100644 (file)
--- a/java/README
+++ b/java/README
@@ -1,5 +1,5 @@
-TurboJPEG/OSS JNI Wrapper
-=========================
+TurboJPEG/OSS Java Wrapper
+==========================
 
 TurboJPEG/OSS can optionally be built with a Java Native Interface wrapper,
 which allows the TurboJPEG/OSS dynamic library to be loaded and used directly
@@ -7,16 +7,13 @@ from Java applications.  The Java front end for this is defined in several
 classes located under org/libjpegturbo/turbojpeg.  The source code for these
 Java classes is licensed under a BSD-style license, so the files can be
 incorporated directly into both open source and proprietary projects without
-restriction.
+restriction.  A Java archive (JAR) file containing these classes is also
+shipped with the "official" distribution packages of libjpeg-turbo.
 
 TJExample.java, which should also be located in the same directory as this
 README file, demonstrates how to use the TurboJPEG/OSS Java front end to
 compress and decompress JPEG images in memory.
 
-  javac TJExample.java
-
-builds .class files for both the front end and example code.
-
 
 Performance Pitfalls
 --------------------
@@ -56,16 +53,3 @@ need to pass an argument of -Djava.library.path=/opt/libjpeg-turbo/lib to java.
 If using a 64-bit data model, then instead pass an argument of
 -Djava.library.path=/opt/libjpeg-turbo/lib/amd64 to use the 64-bit version of
 libturbojpeg.so.
-
-
-Note for MinGW users
---------------------
-
-When libjpeg-turbo is built with MinGW, the TurboJPEG/OSS dynamic library is
-named libturbojpeg.dll instead of turbojpeg.dll.  This is in keeping with the
-convention of MinGW, and it also avoids a filename conflict when the GCC and
-Visual C++ versions of the libjpeg-turbo SDK are installed on the same system.
-However, the TurboJPEG/OSS JNI wrapper will not work on Windows unless the DLL
-is named turbojpeg.dll.  You can work around this by renaming the DLL or by
-simply changing the LoadLibrary() calls in TurboJPEG.java so that they load
-"libturbojpeg" instead of "turbojpeg".