diff --git a/README.md b/README.md index d0ac084..711a53a 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,12 @@ # AnkiJoy # AnkiJoy is a plugin for Anki (version 1.x only) which enables joystick and gamepad support in Linux via pygame. Due to -differences in the Python runtime environment, this plugin does not currently function in Windows (no testing has been -done on Mac OS X). +differences in the Python runtime environment, this plugin does not currently function in Windows. With the help of this +plugin, you can map buttons on your favorite game controller to preset actions in Anki. -With this plugin you can map any of the following actions to arbitrary buttons on your favorite game controller: - -* Answer 1 -* Answer 2 -* Answer 3 -* Answer 4 -* Answer Default -* Answer Incorrect -* Bury Card -* Mark Card -* Repeat Audio -* Show Answer -* Suspend Card -* Undo - -## Requirements ## - -* [Anki 1.x](http://ankisrs.net/download/mirror/archive/) -* [pygame](http://www.pygame.org/) +![](https://foosoft.net/projects/ankijoy/img/gamepad.png) ## Installation ## -To install this extension, simply copy the included `ankijoy.py` file into Anki's `addons` directory. - -## Screenshots ## - -[![Options dialog](https://foosoft.net/projects/ankijoy/img/gamepad-thumb.png)](https://foosoft.net/projects/ankijoy/img/gamepad.png) +1. Make sure [Anki 1.x](http://ankisrs.net/download/mirror/archive/) and [pygame](http://www.pygame.org/) are installed. +2. Copy the included `ankijoy.py` file into the `addons` directory.