Permalink
Browse files

Updated README file for release

  • Loading branch information...
1 parent 2f8b7ae commit 08fa5858da6bbb9a1bf2c79f375606cf79097c26 @thp committed Dec 12, 2012
Showing with 70 additions and 43 deletions.
  1. +70 −43 README
View
113 README
@@ -1,32 +1,68 @@
-PS Move API
-===========
-A cross-platform C library for using the Sony Playstation Move Motion
-Controller, with bindings for Python, Java, Qt and others.
+ ____ _____ __ ___ ___ ____ ____
+ / __ \/ ___/ / |/ /___ _ _____ / | / __ \/ _/
+ / /_/ /\__ \ / /|_/ / __ \ | / / _ \ / /| | / /_/ // /
+ / ____/___/ / / / / / /_/ / |/ / __/ / ___ |/ ____// /
+ /_/ /____/ /_/ /_/\____/|___/\___/ /_/ |_/_/ /___/
-The library is available for Mac OS X, Windows and Linux (USB and Bluetooth).
+ http://thp.io/2010/psmove/
-Basic features:
- * Set the RGB LED color and rumble intensity (USB and Bluetooth)
- * Read digital buttons, analog trigger and sensors (Bluetooth only)
+The PS Move API is an open source[1] library for Linux, Mac OS X and Windows
+to access the Sony Move Motion Controller via Bluetooth and USB directly from
+your PC without the need for a PS3. Tracking in 3D space is possible using a
+PS Eye (on Linux and Windows), an iSight camera (on Mac OS X) or any other
+suitable camera source.
-Advanced features:
+The PS Move API is used as the library implementation of the MoveOnPC[2]
+project, and has successfully participated in Google Summer of Code 2012[3].
+Detailed documentation can be found in my master's thesis[4] about sensor
+fusion.
- * Tracking: Controller tracking with a camera using OpenCV
- * Calibration: Reading of normalized/calibrated values
- * Orientation: Rotation tracking using gyro and accelerometer
-Minimal build dependencies on Ubuntu:
+Core Features
+-------------
- build-essential
- cmake
- libudev-dev
- libbluetooth-dev
+ * Pairing of Bluetooth controllers via USB
+ * Setting LEDs and rumble via USB and Bluetooth
+ * Reading inertial sensors and buttons via Bluetooth
+ * Tracking up to 5 controllers in 3D space via OpenCV
+ * 3D orientation tracking via an open source AHRS algorithm
+ * Sensor fusion for augmented and virtual reality applications
+Supported Languages
+-------------------
-Environment variables:
+ * Core library written in C for portability and performance
+ * SWIG-based bindings for Python, Java, Processing and C#
+
+Need Help?
+----------
+
+ * Free community-based support via the PS Move Mailing List[5]
+ * Professional support and custom development upon request[6]
+
+Building and Installation
+-------------------------
+
+ * See the INSTALL and README.* files for details on building and
+ installing the PS Move API on your system
+ * Build scripts that we use for building binary releases can be found
+ in the contrib/ folder
+ * A debian/ folder is provided for building .deb packages
+ * Contributions (.spec files, etc..) for other distributions welcome
+
+Hacking the Source
+------------------
+
+ * See the LAYOUT file for information on how the source tree is laid out
+ * Coding style: No strict rules; keep consistent with the surrounding code
+ * Patches should be submitted on Github as pull request[7]
+ * Bug reports and feature requests can be added to the issue tracker[8]
+
+Environment Variables
+---------------------
PSMOVE_TRACKER_CAMERA
@@ -57,34 +93,25 @@ Environment variables:
Example: export PSMOVE_TRACKER_WIDTH=1280
export PSMOVE_TRACKER_HEIGHT=720
+More Information
+----------------
+ * License: Simplified BSD-style license (see COPYING)
+ * Maintainer: Thomas Perl <m@thp.io>
+ * Website: http://thp.io/2010/psmove/
+ * Git repository: https://github.com/thp/psmoveapi
+ * Mailing list: psmove@lists.ims.tuwien.ac.at (see [5] for details)
-The PS Move protocol information is based on information from the the linmctool
-and Move On PC projects.
-
-Bindings to the API using C# / Unity are available in "bindings/unity". They
-can be used to create application in the Unity Framework. This project has been
-contributed by the Copenhagen Game Collective (thanks to Douglas Wilson et al)
-and has its own homepage at:
-
- http://www.copenhagengamecollective.org/unimove/
-
-Documentation links:
-
- http://code.google.com/p/moveonpc/wiki/InputReport
-
-Known issues:
-
- * On Debian Wheezy, you might need to specify the path to "swig"
- https://github.com/thp/psmoveapi/issues/5
-Author / contact info: Thomas Perl <m@thp.io>
-Project homepage: http://thp.io/2010/psmove/
-Git repository: https://github.com/thp/psmoveapi
-License: Simplified BSD-style license (see COPYING)
+This README file was last updated on 2012-12-12 by thp
-Initial release date 1.0.0: 2011-03-24
-Release of PSMoveAPI 1.0.2: 2011-12-03
-Updated: 2012-08-07
+[1] https://github.com/thp/psmoveapi/blob/master/COPYING
+[2] http://code.google.com/p/moveonpc/
+[3] http://www.google-melange.com/gsoc/homepage/google/gsoc2012
+[4] http://thp.io/2012/thesis/
+[5] https://lists.ims.tuwien.ac.at/mailman/listinfo/psmove
+[6] http://thp.io/about
+[7] https://github.com/thp/psmoveapi/pulls
+[8] https://github.com/thp/psmoveapi/issues

0 comments on commit 08fa585

Please sign in to comment.