From c3393c5662dab6f597a7bda1571a7535736be668 Mon Sep 17 00:00:00 2001 From: Xiretza Date: Sun, 13 Nov 2022 00:40:28 +0100 Subject: [PATCH] Add setup instructions to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 53c1755..49c04ba 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at). +## Setup + +1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location later specified using `-c, --config`) +2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot user's password. +3. Start the bot using `its-matrix-bot run`. + ## Available commands - `!isitopen`: check if the hackerspace is currently open