aboutsummaryrefslogtreecommitdiffstats
path: root/modules/test/README.md
diff options
context:
space:
mode:
authorTom Feist <shabble@metavore.org>2011-01-09 11:40:33 +0000
committerTom Feist <shabble@metavore.org>2011-01-09 11:40:33 +0000
commit06fd33dafab7e5ce5e96ce5cf5cd8379116185ec (patch)
tree8cb92943c2955f010ef495f2054e274173970a90 /modules/test/README.md
parentuberprompt: added /help prompt to mimic built-in help stuffs. (diff)
downloadirssi-scripts-06fd33dafab7e5ce5e96ce5cf5cd8379116185ec.tar.gz
irssi-scripts-06fd33dafab7e5ce5e96ce5cf5cd8379116185ec.zip
module/test: documented it a bit better, and add an unload message.
Diffstat (limited to 'modules/test/README.md')
-rw-r--r--modules/test/README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/modules/test/README.md b/modules/test/README.md
index bc98767..0c92477 100644
--- a/modules/test/README.md
+++ b/modules/test/README.md
@@ -12,9 +12,18 @@ Note that modules are significantly more effort (and less portable, without
a huge amount of effort), so Perl scripts are to be preferred in call cases
where possible.
+## 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 test`
+* Party in the streets.
+
## Contributing
-Contributions to this project are welcome
+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
@@ -31,11 +40,11 @@ Contributions to this project are welcome
## Authors
- * Alexander Færøy &lt;ahf@irssi.org&gt;
+ * Alexander Færøy <ahf@irssi.org>
Original Author of irssi-lua, who did all the hard work figuring
out the module interface stuff. Also an Irssi project committer, I
believe, so that probably counts as cheating.
- * Tom Feist `&lt;shabble+irssi@metavore.org&gt;`
-
+ * Tom Feist `[shabble+irssi@metavore.org](mailto://shabble+irssi@metavore.org)`
+ Chief plunderer of the modular goodness.