diff options
| author | Tom Feist <shabble@metavore.org> | 2011-01-09 15:47:19 +0000 |
|---|---|---|
| committer | Tom Feist <shabble@metavore.org> | 2011-01-09 15:47:19 +0000 |
| commit | d09b996009ec577b484caaab5dcbf5f18ad84c83 (patch) | |
| tree | e2d2ddbac61b6146e79f71da9b6d1c3a5197abf3 /modules/key_emitter/README.md | |
| parent | ido-mode/ido_switcher: added a ido_show_active_first setting to prioritise (diff) | |
| download | irssi-scripts-d09b996009ec577b484caaab5dcbf5f18ad84c83.tar.gz irssi-scripts-d09b996009ec577b484caaab5dcbf5f18ad84c83.zip | |
cloned test module to start work on a useful module
Diffstat (limited to 'modules/key_emitter/README.md')
| -rw-r--r-- | modules/key_emitter/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/modules/key_emitter/README.md b/modules/key_emitter/README.md new file mode 100644 index 0000000..6377a39 --- /dev/null +++ b/modules/key_emitter/README.md @@ -0,0 +1,36 @@ +## What is this? + +A loadable module which processes keybindings and emits easier to handle +signals for scripting. + +## Usage + +* Edit the Makefile as per the comments at the top. +* `make && make install` +* Start up a spare Irssi client (no point segfaulting your main one) +* `/load key_emitter` +* Party in the streets. + +## Contributing + +Contributions to this project are welcome (i.e.: to demonstrate more useful +things that a module can do) + + * Patches can be submitted via e-mail, or preferably via forking + and sending a pull-request using GitHub. The repository for this + code is `git://github.com/shabble/irssi-scripts.git` and the + corresponding web-page is + [irssi-scripts/modules](https://github.com/shabble/irssi-scripts/modules). + + Details of pull-requests can be found at + [GitHub](http://help.github.com/pull-requests/) + + . Please poke me on Freenode IRC (`shabble` on `#irssi`) before + spending too much time on the code. Use the `git format-patch`-tool when + emailing patches. + +## Authors + + * Tom Feist [shabble+irssi@metavore.org](mailto://shabble+irssi@metavore.org) + Chief plunderer of the modular goodness. + |