aboutsummaryrefslogtreecommitdiffstats
path: root/modules/key_emitter/README.md
blob: 6377a3990b887c853a8d4147fdb4904801f5ecba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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.