aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTom Feist <shabble@metavore.org>2011-04-18 00:42:34 +0000
committerTom Feist <shabble@metavore.org>2011-04-18 00:42:34 +0000
commitf224f8fe2f7979fb18ea3a31a4c04012bac0ec43 (patch)
tree3b7281a14c2ca7928f60631c13339b41ae0d1eb0 /README.md
parentundo: updates to kill-ring, implementing most of the basic functionality. (diff)
downloadirssi-scripts-f224f8fe2f7979fb18ea3a31a4c04012bac0ec43.tar.gz
irssi-scripts-f224f8fe2f7979fb18ea3a31a4c04012bac0ec43.zip
updated root README to mention some of the newer stuff.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 34c291d..51c7dcf 100644
--- a/README.md
+++ b/README.md
@@ -28,12 +28,16 @@ to use them.
* `feature_tests/` has a bunch of different little scripts written to test certain
aspects of Irssi behaviour. None of them are likely to be particularly useful
unless you're looking for simple examples of various things on which to build.
- The exception is 'key_test.pl', which is good for figuring out what keycodes
- Irssi sees when you give it input.
-
- pipes.pl might also be interesting as a barebones template for a script which
- uses forking and pipes to handle async tasks in the background without hanging
- Irssi.
+ Some of the ones which might actually be useful are:
+
+ * `key_test.pl` - decodes and prints keyboard inputs from the `gui key pressed`
+ signal. Useful for checking what keycode a particular combo generates.
+
+ * `template.pl` - A basic outline of a script to use as a starting point
+ for others.
+
+ * `pipes.pl` A barebones template for a script which uses forking and pipes
+ to handle async tasks in the background without hanging Irssi.
* `modules/` contains a few half-baked attempts at loadable modules for Irssi,
none of which do very much at the moment. They might be useful as templates
@@ -71,6 +75,9 @@ to use them.
ask you to confirm that you want to send the message, much like
`scrolled_reminder`.
+* `undo/` contains 2 scripts, `undo.pl` and `kill-ring.pl`. See their header
+ for further documentation.
+
* `testing/` is a Perl framework external to Irssi (ie: not a script) that will
ultimately allow you to write unit tests for your scripts, and run them in a
real irssi instance, and check that they behave correctly. Still undergoing