Add README

This commit is contained in:
Yash Karandikar 2022-05-11 12:22:55 -05:00
parent ff60d6b798
commit 694b8f49f9

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# weechat-notify
tiny notification script for weechat.
i wrote this because all of the other notification scripts i could find didn't do something i wanted or were broken in another way.
requires: rust, notify-send, python
to build, first run `cargo build --release` then move `plugin.py` and the generated .so (`target/release/libwn_backend.so`) to your python script directory (probably `~/.local/share/weechat/python` but could also be `~/.weechat/python`). then rename the .so to `libwn_backend.so`
next, run `/script load weechat-notify.py` and enjoy your notifications!