summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLaura <the-ceo-of-antifa@protonmail.com>2023-01-22 13:59:35 +0100
committerLaura <the-ceo-of-antifa@protonmail.com>2023-01-22 13:59:35 +0100
commit037561fd2e2caf0ddb894cac05ca19b5840d4ae2 (patch)
tree7cb396428960dba58a78b04c7399a2df4d8cb141 /README.md
parent7cd4f6ea6999f8b88a03c93d8d9ef306d4356065 (diff)
downloadmiaowe-037561fd2e2caf0ddb894cac05ca19b5840d4ae2.tar.gz
miaowe-037561fd2e2caf0ddb894cac05ca19b5840d4ae2.zip
less hard-coding
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index abf9083..5fef47f 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,9 @@ To build:
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" (in the parent of miaowe's PWD), on the first line and separated by a space. Image files are read from the working directory. If nya.sh is used, image_directory becomes miaowe's PWD.
+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. Image files are read from the working directory. If nya.sh is used, image_directory becomes miaowe's PWD.
+
+Miaowe expects to find a configuration file with the name "conf" in its PWD's parent directory. This should be in a key-value format, one entry per line. Strings should not be quoted; anything after the first space is considered part of the value. It should include the following keys: "nick", "username", "realname", "credentials". "Credentials" should be the NickServ password, or username and password separated by a space.
Available commands:
* List -- lists all files in PWD