IT-Syndikat/its-matrix-bot
14
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

README: add more instructions

Browse source
This commit is contained in:
Xiretza 2022-11-13 09:20:36 +01:00
parent 047f64c5db
commit a8654a6ef3
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -4,6 +4,10 @@ Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at).
## Setup ## 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 1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location
later specified using `-c, --config`) later specified using `-c, --config`)
2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot 2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot