Split view management out of NJDeviceController. Right now this probably just makes...
[enjoyable.git] / README.md
index 2a7c478..22ed9c6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,59 @@
-Enjoy2
-======
+Enjoyable
+=========
 
-Enjoy2 is a simple program for Mac OSX that allows you to transform joystick inputs into keyboard or mouse events.
+Enjoyable is an application for Mac OS X which allows you to use
+controller inputs like a mouse or keyboard. If you've ever played a
+video game which only supports mouse and keyboard input but you want
+to use a joystick or gamepad, then Enjoyable is the program for you.
 
-If you've ever played a video game which only supports mouse and keyboard input, but you want to use a joystick or gamepad, then Enjoy2 is the program for you. Enjoy2 lets you map your joystick inputs to:
+Enjoyable supports
 
-* Key events
-* Mouse clicks
-* Mouse movement (for analog sticks)
-* Scrolling
+ * Mapping gamepad and joystick buttons to keyboard and mouse actions
+ * Fine control over mouse movement and scrolling using analog axis
+   inputs
+ * Automatic and dynamic switching between different input mappings
+ * Downloading and sharing input presets for different applications
+ * Modern OS X features like resume and automatic termination
 
-Enjoy2 supports multiple configurations (for different games or programs) and you can even map joystick buttons to change configurations on-the-fly.
+Enjoyable is free software written by Joe Wreschnig and is based on
+the Enjoy codebase written by [Yifeng Huang](http://nongraphical.com)
+and [Sam McCall](http://abstractable.net/enjoy/).
 
-Enjoy2 is written by [Yifeng Huang](htty://nongraphical.com) and is based on [Enjoy by Sam McCall](http://abstractable.net/enjoy/). Enjoy is MIT-licensed.
+## How to Use
 
-## How to use
+To start, just press a button on your joystick or gamepad, then press
+the key you want to map it for. Then press the ▶ button and switch
+back to your game. For more details, Enjoyable has a in-application
+manual available in Help Viewer via `⌘?`.
 
-At startup, and when Enjoy2 is paused, press any button or move any analog stick to jump to the configuration for that button or stick. From there, select one of the mapping options from the choices on the right.
-
-To use an analog axis to move the mouse, select the "Analog" sub-item on the left.
+## Requirements
 
-### Mapping modes
+* Mac OS X 10.7+
+* One or more HID-compatible (e.g. USB or Bluetooth) input devices
 
-Enjoy2 offers two mouse mapping modes: global and single-window. Enjoy2 starts in global mode, but you can set any joystick button to the "toggle mouse scope" action, which will change the mode. If you are using Enjoy2 to play a video game, you may find that one or the other mode offers better compatibility with your game's specific requirements.
+## License
 
-## Requirements
+Copyright 2013 Joe Wreschnig  
+          2012 Yifeng Huang  
+          2009 Sam McCall, University of Otago
 
-* Mac OS X 10.6 (Snow Leopard) or higher
-* USB gamepad/joystick/controller
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-## Changelog
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-Version 1.1
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-* Forked from Enjoy
-* Mouse movement support
-* Mouse button support
-* Scrollwheel support
-* Support for two mouse movement modes
+The joystick icon is from the Tango icon set and is public domain.