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

Compare commits

base: IT-Syndikat:7031f9f82b9a10500e8a6483ed4733af9d009e1b
Branches Tags
IT-Syndikat:main
IT-Syndikat:python-legacy
...
compare: IT-Syndikat:a8654a6ef392a75aa56fd0e5931f460b5a1e3879
Branches Tags
IT-Syndikat:main
IT-Syndikat:python-legacy

2 commits
7031f9f82b ... a8654a6ef3

Author SHA1 Message Date
Xiretza a8654a6ef3 README: add more instructions 2022-11-13 09:20:36 +01:00
Xiretza 047f64c5db README: reflow 2022-11-13 09:20:18 +01:00
1 changed files with 12 additions and 3 deletions
Show stats Expand all files Collapse all files

15
README.md
View file

@ -4,11 +4,20 @@ 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.
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
user's password.
3. Start the bot using `its-matrix-bot run`.
## Available commands
- `!isitopen`: check if the hackerspace is currently open
- `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix messages
- `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix
messages
<!-- vim: set tw=100: -->