aboutsummaryrefslogtreecommitdiffstats
path: root/modules/test/README.md
diff options
context:
space:
mode:
authorTom Feist <shabble@metavore.org>2011-01-01 17:38:55 +0000
committerTom Feist <shabble@metavore.org>2011-01-01 17:38:55 +0000
commitfc84e55acd28bb7da2d104c0cd9a7487f261b7b5 (patch)
tree3609741634da3db93d7889ea30d29054af852e18 /modules/test/README.md
parentMerge branch 'dev' of github.com:shabble/irssi-scripts into dev (diff)
downloadirssi-scripts-fc84e55acd28bb7da2d104c0cd9a7487f261b7b5.tar.gz
irssi-scripts-fc84e55acd28bb7da2d104c0cd9a7487f261b7b5.zip
module_test: The tiny beginnings of an irssi loadable-module (not script) for
educational and internals poking purposes. Hopefully one day it might grow up to be a real binary! See README for details on the code I "borrowed" from ahf. I hope I attributed it all ok :)
Diffstat (limited to '')
-rw-r--r--modules/test/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/modules/test/README.md b/modules/test/README.md
new file mode 100644
index 0000000..bc98767
--- /dev/null
+++ b/modules/test/README.md
@@ -0,0 +1,41 @@
+## What is this?
+
+A simple Irssi C module for testing and experimentation purposes.
+It was originally derived from the
+[irssi-lua project](https://github.com/ahf/irssi-lua)
+
+I intend to build it into a simple template of a loadable module, featuring
+the use of various common constructs, to allow others to quickly get
+up to speed when developing modules.
+
+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.
+
+## Contributing
+
+Contributions to this project are welcome
+
+ * 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
+
+ * Alexander Færøy &lt;ahf@irssi.org&gt;
+ 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;`
+
+