Initial check-in of the Java Games Initiative's game controller discovery and input library.

git-svn-id: file:///home/sven/projects/JOGL/git-svn/svn-server-sync/jinput/trunk@3 e343933a-64c8-49c5-92b1-88f2ce3e89e8

1 files changed, 81 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..3b191e3
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,81 @@
+Project: net.java.games.*
+Purpose: Open source game libraries
+Authors: 
+    -- input API design:
+            Michael Martak, Sun Microsystems	
+            Thomas Daniel, Sony Computer Entertainment
+    -- input API original author: 
+            Michael Martak,Sun Microsystems
+    -- input API original release author:  
+            Jeff Kesselman, Game Technology Architect, 
+            Advanced Software Technologies Group,
+            Sun Microsystems.
+    -- this file updated on 06/06/2003 by Jeff Kesselman
+
+
+Introduction:
+
+This is the source tree for the Java Game Initiative (JGI) Open Source
+client game programming APIs.
+
+Build Requirements:
+
+This project has been built in the follwing environment.
+ -- Win32 (Win 2000 in the case of our machine)
+ -- Sun J2SDK 1.4 (available at java.sun.com)
+ -- 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
+     -- "Peter Puck's" directx8 binding 
+	(http://www.urebelscum.speedhost.com/download.html, file: dx8libs.zip
+ -- ANT 1.4.1 (available at apache.org)
+
+
+Directory Organization:
+
+The root contains a master ANT build.xml and the following sub directories:
+ -- coreAPI:  The actual API
+ -- plugins:  Directories for bildign controlelr plugins.
+		(Currently the only plug in is the Win32 DX8 plugin.)
+
+Build instructions:
+
+To clean: ant clean
+To build:  ant all (or just ant)
+To build docs: ant javadoc
+To test: 
+	First cd to coreAPI.  There are currently 2 tests there.
+		Textest: A simple discovery test that dumps
+			the data about the discovered controllers to stdout
+			To run: ant textest
+		Readtest:  A test that creates a window for each discovered
+			controller (or sub-controller) which displays the
+			current state of all the controller's axiis.
+			(Note: The windows currrently all open at the same
+			 place on the screen so yo uwill have to move them to
+			 see them all.)
+			To run: ant readtest
+    
+Release Info:
+    Initial Release:  This release contains an implementation of the input
+        API designed by Mike Martak of Sun and Thomas (?) of Sony CEA for
+        the WIn32 platform.  All the code in src/input is cross platform. The
+        Win32 code is segregated to the DirectX plugin (src/DXplugin) which
+        depends on DirectInput from DX7 (or later).
+
+    05/09/2003:  A number of bugs and problems with the DXPlugin are fixed in this
+	release.  This release also brings the code up to date using the DI8
+	interface.  This thus is the first release that requries Peter Puck's
+	DX8 bindings to compile with MinGW.
+
+    05/09/2003 (second update):
+	This version adds a new standard value type to the API.
+	Axis.POV holds standard definitions for values for POV (hat) switches
+		-- Axis.POV.CENTER and Axis.POV.OFF are synonmous and are
+			the center position.
+		-- Axis.POV.UP, Axis.POV.DOWN, Axis.POV.LEFT and Axis.POV.RIGHT
+		   should be self explainatory.
+	Any hat that claims to be "normalized" will return these values. (It is
+	recommended that all hats be normalized by the systemn specific plugins.)
+