colin
/
billbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Matrix bot to track informal debts between some (small) group of individuals.
8 Commits 1 Branch 0 Tags 61 KiB
Rust 77.9%
Nix 22.1%
Go to file
Colin c5005a6613 consider implementing this as a widget 2023-04-22 04:52:07 +00:00
doc consider implementing this as a widget 2023-04-22 04:52:07 +00:00
src minimal bot which responds to pings (in unencrypted rooms only) 2023-04-01 16:03:57 +00:00
.gitignore ignore cargo and nix artifacts 2023-04-01 16:07:25 +00:00
Cargo.lock minimal bot which responds to pings (in unencrypted rooms only) 2023-04-01 16:03:57 +00:00
Cargo.toml minimal bot which responds to pings (in unencrypted rooms only) 2023-04-01 16:03:57 +00:00
README.md consider implementing this as a widget 2023-04-22 04:52:07 +00:00
flake.lock place scaffolding that enables cargo and nix builds 2023-04-01 14:28:46 +00:00
flake.nix minimal bot which responds to pings (in unencrypted rooms only) 2023-04-01 16:03:57 +00:00

README.md

:B:illBöt

To 🅱️reserve and prötec

This will be a Matrix bot used to track informal debts between some (small) group of individuals.

its goals are (in order of importance):

  1. any party can recalculate their position(s) even when the bot is unreachable.
  2. support 1-to-1 and 1-to-many "transactions".
  3. transactions may be visible to only the direct parties involved.
  4. upgradable without any manual migration.
  5. optional reminders for outstanding debts.

but so far, :B:illBöt achieves exactly 0 of these 🙃

Roadmap

a few proposals:

Development/Hacking

this project is built with cargo, the Rust package manager. simply run:

$ cargo build
$ ./target/debug/billbot

it can also be built with nix:

$ nix build
$ ./result/bin/billbot

a nix development environment (i.e. access to the correct toolchain) can be entered like so:

$ nix develop

after which ordinary cargo commands can be used:

nix-shell> cargo build
nix-shell> ./target/debug/billbot

refer to <./doc/resources.md> for code-related documentation.