README.md in artoo-joystick-0.3.0 vs README.md in artoo-joystick-0.4.0
- old
+ new
@@ -1,23 +1,37 @@
# Artoo Adaptor For Joysticks & Game Controllers
-This repository contains the Artoo (http://artoo.io/) adaptor for the PS3 game controller, XBox360 game controller, or any other joysticks and game controllers that are compatible with Simple DirectMedia Layer (SDL) (http://www.libsdl.org/).
+This repository contains the Artoo (http://artoo.io/) adaptor for the PS3 controller, Xbox 360 controller, or any other joysticks and game controllers that are compatible with Simple DirectMedia Layer (SDL) (http://www.libsdl.org/).
Artoo is a open source micro-framework for robotics using Ruby.
For more information about Artoo, check out our repo at https://github.com/hybridgroup/artoo
-The artoo-joystick adaptor uses the rubysdl gem (http://www.kmc.gr.jp/~ohai/rubysdl.en.html).
+The artoo-joystick adaptor uses the ruby-sdl-ffi gem (https://github.com/hybridgroup/ruby-sdl-ffi).
[](https://codeclimate.com/github/hybridgroup/artoo-joystick) [](https://travis-ci.org/hybridgroup/artoo-joystick)
## Installing
+### OSX
+
```
+brew install sdl
gem install artoo-joystick
```
+Mac OS X does not provide native support for XBox 360 controllers. A third-party driver is available from http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/OsxDriver
+
+
+### Ubuntu
+
+```
+sudo apt-get install libsdl1.2-dev
+gem install artoo-joystick
+```
+
+
## Using
```ruby
require 'artoo'
@@ -43,14 +57,51 @@
end
```
## Connecting to USB Joysticks and Game Controllers
-Plus your USB joystick or game controller into your USB port. If your device is supported by SDL, you are now ready.
+Plug your USB joystick or game controller into your USB port. If your device is supported by SDL, you are now ready.
+### Additional XBox 360 Controller Information
+
+Trigger button events are published to :trigger_lt and :trigger_rt for the XBox 360 controller.
+
+```ruby
+require 'artoo'
+
+connection :joystick, :adaptor => :joystick
+device :controller, :driver => :xbox360, :connection => :joystick, :interval => 0.1
+
+work do
+ on controller, :trigger_lt => proc { |*value|
+ puts "trigger lt: #{value[1]}"
+ }
+ on controller, :trigger_rt => proc { |*value|
+ puts "trigger rt: #{value[1]}"
+ }
+end
+```
+
+## Documentation
+
+Check out our [documentation](http://artoo.io/documentation/) for lots of information about how to use Artoo.
+
+## IRC
+
+Need more help? Just want to say "Hello"? Come visit us on IRC freenode #artoo
+
## Contributing
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* All patches must be provided under the Apache 2.0 License
+* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
+* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
+* We will look at the patch, test it out, and give you feedback.
+* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
+* Take care to maintain the existing coding style.
+* Add unit tests for any new or changed functionality.
+* All pull requests should be "fast forward"
+ * If there are commits after yours use “git rebase -i <new_head_branch>”
+ * If you have local changes you may need to use “git stash”
+ * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+
+
+(c) 2012-2014 The Hybrid Group