From c5d291f11ee8c7be6a98ee7b86f32b1b67b72c62 Mon Sep 17 00:00:00 2001 From: Laura Date: Thu, 5 Jan 2023 15:21:32 +0100 Subject: add readme, gitignore --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 + +or: + ./nya.sh -- cgit v1.2.3