summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHubert Hirtz <hubert@hirtz.pm>2020-11-29 12:27:52 +0100
committerHubert Hirtz <hubert@hirtz.pm>2020-11-29 12:58:10 +0100
commitc79110642bc0f7accd8ec312ef03535e60256ed1 (patch)
tree6ec42b78bdee45caaea318f5587f7f57ddb3700b /README.md
parentDon't forward outdated typing timeouts (diff)
Make cmd/test usable
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index aaee433..705d1e3 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,6 @@ mkdir -p ~/.config/senpai
cat <<EOF >~/.config/senpai/senpai.yaml
addr: irc.freenode.net:6697
nick: senpai
-real: Senpai is the best senpai
-user: sasluser
password: "my password can't be this cute"
EOF
go run ./cmd/irc
@@ -25,6 +23,16 @@ Then, type `/join #senpai` and have a chat!
See `doc/senpai.1.scd` for more information and `doc/senpai.5.scd` for more
configuration options!
+## Debugging errors, testing servers
+
+If you run into errors and want to find the WHY OH WHY, or if you'd like to try
+things out with an IRC server, then you have two options:
+
+1. Run senpai with the `-debug` argument (or put `debug: true`) in your config,
+ it will then print in `home` all the data it sends and receives.
+2. Run the test client, that uses the same IRC library but exposes a simpler
+ interface, by running `go run ./cmd/test -help`.
+
## Contributing and stuff
Patches are welcome at <mailto:~taiite/public-inbox@lists.sr.ht>!