summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsugarshark <[email protected]>2003-08-18 23:59:50 +0000
committersugarshark <[email protected]>2003-08-18 23:59:50 +0000
commit4889608fa78a1c8da7ad699e1550e20a639905fb (patch)
tree997e8a48c58ad808a5233ef6240b18f846f86ee1
parent7eed4a3df684588b6edcd2dd1e6222f7a1731b77 (diff)
* .cvsignore: new file
* README.txt : describe Linux build CVS: ---------------------------------------------------------------------- CVS: Issue number: CVS: If this change addresses one or more issues, CVS: then enter the issue number(s) here. CVS: Obtained from: CVS: If this change has been taken from another system, CVS: then name the system in this line, otherwise delete it. CVS: Submitted by: CVS: If this code has been contributed to the project by someone else; i.e., CVS: they sent us a patch or a set of diffs, then include their name/email CVS: address here. If this is your work then delete this line. CVS: Reviewed by: CVS: If we are doing pre-commit code reviews and someone else has CVS: reviewed your changes, include their name(s) here. CVS: If you have not had it reviewed then delete this line. git-svn-id: file:///home/mbien/NetBeansProjects/JOGAMP/joal-sync/git-svn/../svn-server-sync/joal/trunk@50 03bf7f67-59de-4072-a415-9a990d468a3f
-rw-r--r--.cvsignore3
-rw-r--r--README.txt83
2 files changed, 69 insertions, 17 deletions
diff --git a/.cvsignore b/.cvsignore
new file mode 100644
index 0000000..5f3caa4
--- /dev/null
+++ b/.cvsignore
@@ -0,0 +1,3 @@
+apidocs
+classes
+lib
diff --git a/README.txt b/README.txt
index a927199..527ce08 100644
--- a/README.txt
+++ b/README.txt
@@ -40,48 +40,97 @@ Author:
Java Games Initiative
Software Advanced Technologies Group,
Sun Microsystems
- -- This file updated 06/02/2003
+ -- This file updated 08/19/2003 by Ole Arndt <ole at sugarshark dot com>
Introduction:
+=============
This is the source tree for the Java Game Initiative (JGI) Open Source
client game programming APIs for OpenAL and Sound3D.
+
Build Requirements:
+===================
+
+This project has been built under Win32 and Linux. The following
+packages and tools have been used:
-This project has been built in the following environment.
- -- Win32 (Win XP in the case of our machine)
- -- Sun J2SDK 1.4.2 (available at java.sun.com)
- -- OpenAL1.0 SDK from Creative Labs (available at http://developer.creative.com
- under "Gaming -> Development Kits -> Open AL")
- -- MinGW 2.0.0 plus the following updates: (all available at www.mingw.org)
+* All Systems:
+ -- Sun J2SDK 1.4.2 (available at java.sun.com)
+ -- ANT 1.5.3 (available at apache.org)
+ -- JUnit 3.8.1 (available at junit.org) copy junit.jar to the apache-ant lib directory
+
+* Windows:
+ -- Win32 (Win XP in the case of our machine)
+ -- OpenAL1.0 SDK from Creative Labs (available at http://developer.creative.com
+ under "Gaming -> Development Kits -> Open AL")
+ -- MinGW 2.0.0 plus the following updates: (all available at www.mingw.org)
-- binutils 2.13.90
-- w32api-2.2
-- mingw-runtime-2.4
- -- ANT 1.5.3 (available at apache.org)
- -- JUnit 3.8.1 (available at junit.org) copy junit.jar to the apache-ant lib directory
+
+* Linux:
+ -- Linux i386 (Redhat 9.0)
+ -- gcc 3.2.2, binutils 2.13.90
+ -- OpenAL CVS version from opensource.creative.com (see CVS instructions at
+ www.openal.org)
+
+* OSX
+ -- to be ported
+
Directory Organization:
+=======================
The root contains a master ANT build.xml and the following sub directories:
- -- apidocs Where the javadocs get built to
- -- lib Where the Jar and DLL files get built to
- -- src The actual source for the JGI APIs.
- -- www JGI project webpage files
-Build instructions:
+ -- apidocs Where the javadocs get built to
+ -- lib Where the Jar and DLL files get built to
+ -- src The actual source for the JGI APIs.
+ -- www JGI project webpage files
+
+
+Preparations:
+=============
+
+* Windows:
+ Grab the OpenAL SDK from the openal.org downloads and install it.
+
+* Linux:
+ OpenAL comes with various Linux distributions. You might have it already.
+ If not, try rpmfind, apt-get or emerge.
+
+ For the newest version you need to compile OpenAL yourself from CVS:
+
+ -- follow the instruction at www.openal.org to check out a fresh copy
+ -- in the linux subdir type './autogen.sh
+ -- look at the build options
+ -- configure it with./configure --enable-sdl --enable-vorbis [-enable-more]
+ (look in openal.spec for a
+ -- build it with make && make test and run the tests
+ -- as root type make install
+ -- add /usr/local/lib to you /etc/ld.so.conf and run ldconfig
+
+
+JOAL Build Instructions:
+===================
Edit the value of the jdk.home property in the root build.xml file to point
-to your Java 2 SDK installation (ex: c:/j2sdk1.4.2)
+to your Java 2 SDK installation (ex: c:/j2sdk1.4.2 or /opt/j2sdk1.4.2)
Edit the value of the openal.home property in the root build.xml file to point
-to your OpenAL SDK installation (ex: c:/program files/creative labs/openal 1.0 sdk)
+to your OpenAL SDK installation. For Windows this might be
+"c:/program files/creative labs/openal 1.0 sdk".
+Under Linux set the property to the toplevel directory of your OpenAL CVS version.
+If OpenAl came with your distribution and the header files are in /usr/include/AL,
+set the property to '/usr'.
To clean: ant clean
-To build: ant all (or just ant)
+To build: ant all (or just ant)
To build docs: ant javadoc
To test: ant runtests
+
Release Info:
Initial Release: This release contains an implementation of the Java
bindings for OpenAL, as well as the Sound3D Object-Oriented toolkit for games.