Browse files

Moved most of clois-lane's common-lisp.net content to README.md.

  • Loading branch information...
1 parent a496333 commit 6624f55f03c94298f6a8749ec3000c5a48c82103 @aerique committed Jan 28, 2010
Showing with 43 additions and 0 deletions.
  1. +43 −0 README.md
View
43 README.md
@@ -0,0 +1,43 @@
+# clois-lane
+
+## CFFI bindings to OIS
+
+
+### Introduction
+
+clois-lane provides CFFI bindings to the
+[OIS](http://en.wikipedia.org/wiki/Object_Oriented_Input_System)
+library.
+
+The Object-Oriented Input System (OIS) is the default input system for
+[Ogre](http://www.ogre3d.org/) and these CFFI bindings work together
+with the [Okra](http://github.com/aerique/okra) project which provides
+access to Ogre from Common Lisp.
+
+
+### License
+
+This project is released under the simplified
+[BSD](http://www.opensource.net/licenses/bsd-license.php) license.
+
+
+### To Do
+
+* add joystick support
+* add Wii support (Windows only?)
+* make OS device settings that are hardcoded in C++ configurable from
+ CL
+
+
+### Platforms
+
+The code has currently been tested on Linux using SBCL and on Windows
+XP using Clozure CL and MinGW.
+
+
+### Version numbering
+
+clois-lane follows the OIS version numbering with its own version
+number tagged on at the end. This way you can easily see which version
+of OIS these bindings are written for and what the latest release of
+clois-lane itself is.

0 comments on commit 6624f55

Please sign in to comment.