diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..58c53a5 --- /dev/null +++ b/README.rst @@ -0,0 +1,40 @@ +G15MACRO +======== + +A simple Macro recording/playback app for G15Daemon. + +======== +Features +======== + +- Records both keyboard and mouse activity, playback via 'G' hotkey. +- Up to 56 macros can be created (using the 'M' keys to select a palette). +- Each macro can have up to 128 steps + +============ +Requirements +============ + +- X11 +- libg15render +- XTEST + +===== +Usage +===== + +To Record a macro: +------------------ + +1. Press the 'M' key for the palette you wish to set, if not already selected. +2. Press the MR key +3. Enter the keystrokes required +4. Press the 'G' key you want to hold the macro. + +To Playback a previously recorded macro: +---------------------------------------- + +1. Press the 'M' key for the palette you wish to playback, if not already selected. +2. Press the 'G' key containing the macro. + +