Convert the README to the Markdown format
This commit is contained in:
parent
b9ce772889
commit
7de9bd8406
35
README
35
README
|
@ -1,37 +1,39 @@
|
|||
= XBMC Wiimote Gateway
|
||||
XBMC Wiimote Gateway
|
||||
====================
|
||||
|
||||
An XBMC event client that receives input from a Wii remote via bluetooth
|
||||
and feeds them to XBMC.
|
||||
|
||||
== Features
|
||||
Features
|
||||
--------
|
||||
|
||||
* Automatic disconnect after a period of disuse
|
||||
* On connect…
|
||||
- notifications in XBMC,
|
||||
- rumble, and
|
||||
- battery status report
|
||||
* notifications in XBMC,
|
||||
* rumble, and
|
||||
* battery status report
|
||||
* Supports key repeating when holding a button down
|
||||
* Rudimentary error handling
|
||||
* Usage of a specific Wii remote to be able to pair quickly
|
||||
* Uses the official XBMC EventServer API (see also [1])
|
||||
* Uses the default Wii remote keymap shipped with XBMC (see also [2])
|
||||
* Uses the official XBMC [EventServer API](http://wiki.xbmc.org/?title=EventServer#Event_Clients_and_the_EventServer)
|
||||
* Uses the default [Wii remote keymap](https://github.com/xbmc/xbmc/blob/master/system/keymaps/joystick.WiiRemote.xml)
|
||||
shipped with XBMC
|
||||
|
||||
1: http://wiki.xbmc.org/?title=EventServer#Event_Clients_and_the_EventServer
|
||||
2: https://github.com/xbmc/xbmc/blob/master/system/keymaps/joystick.WiiRemote.xml
|
||||
|
||||
== Requirements
|
||||
Requirements
|
||||
------------
|
||||
|
||||
XBMC Wiimote Gateway is an XBMC event client, so it needs:
|
||||
|
||||
* XBMC Dharma (>= 10.1), with
|
||||
- XBMC Event Client Python bindings
|
||||
* XBMC Event Client Python bindings
|
||||
* Python (>= 2.6), with
|
||||
- Python CWIID bindings (>= 0.6)
|
||||
* Python CWIID bindings (>= 0.6)
|
||||
* Bluez (>= 4.96)
|
||||
|
||||
and of course a working bluetooth controller.
|
||||
|
||||
== Installation & Use
|
||||
Installation & Use
|
||||
------------------
|
||||
|
||||
The script itself, xbmc-wiimote, can be put anywhere. Preferably, put it
|
||||
somewhere that is in the system's/in your path.
|
||||
|
@ -49,7 +51,8 @@ If you don't know the bluetooth address of your Wii remote, run
|
|||
|
||||
and quickly press 1+2 on the Wii remote to find the address
|
||||
|
||||
== License
|
||||
License
|
||||
-------
|
||||
|
||||
XBMC Wiimote Gateway free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by the
|
||||
|
@ -64,6 +67,6 @@ more details.
|
|||
You should have received a copy of the GNU General Public License along
|
||||
with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
N.B. The source code of this program includes code from
|
||||
*N.B.* The source code of this program includes code from
|
||||
http://code.activestate.com/recipes/577407/ which is licensed under the
|
||||
Apache License 2.0, see also: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
|
|
Loading…
Reference in New Issue