From 06f93a2a3472398abe2da01e309dcc615fc5d402 Mon Sep 17 00:00:00 2001 From: shoshin Date: Sun, 16 Oct 2022 21:11:51 -0500 Subject: Docs: config notes --- README.md | 14 ++++++++++++++ snekeyes.asd | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aacd1e7..da8123e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Dice rolling bot for Matrix using the granolin bot framework. More documentation will come... +## Setup + +Create a `snekeyes.config` file in the directory from which +you will launch the bot. + +``` +(:ssl t ;; in the case of a local testing server, the default is t + :hardcopy "snekeyes.hardcopy" ;; for recovering sessions, this file will be created + :user-id "some-id" ;; the user you have already created on your server for the bot + :password "some-password" + :homeserver "matrix.cicadas.surf" ;; or your real one +) +``` + ## Commands Currently, `snekeyes` supports two commands: diff --git a/snekeyes.asd b/snekeyes.asd index 880532a..d309fc1 100644 --- a/snekeyes.asd +++ b/snekeyes.asd @@ -2,7 +2,7 @@ (asdf:defsystem #:snekeyes :description "A Matrix bot to roll dice." - :author "Shoshin " + :author "Shoshin " :license "AGPL" :version "0.0.1" :serial t -- cgit v1.2.3