From a8654a6ef392a75aa56fd0e5931f460b5a1e3879 Mon Sep 17 00:00:00 2001 From: Xiretza Date: Sun, 13 Nov 2022 09:20:36 +0100 Subject: [PATCH] README: add more instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8d5802d..55ff16e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at). ## Setup +For all these steps, either install the binary using `cargo install` and then run it as +`its-matrix-bot`, or run the project directly from the repository using `cargo run --` (e.g. `cargo +run -- 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