diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc7a416 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Miaowe +Miaowe is an IRC bot that prints out image files (PPM at the moment) using mIRC colour codes on request. + +Dependencies: +* GHC + +To build: + make + +The resulting executable will be called "miaowe". + +Miaowe includes no networking code of its own, but assumes stdin and stdout will be connected to an IRC server. A zsh script, nya.sh, is included to help with this. Users of other shells may need to adjust the script to work with their shell. NickServ login credentials are placed in a file called "conn", on the first line and separated by a space. + +To run: + ./miaowe <channel> + +or: + ./nya.sh <channel> |