diff options
| -rw-r--r-- | README.org | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..7dd5eab --- /dev/null +++ b/README.org @@ -0,0 +1,35 @@ +#+TITLE: catinator + +catinator is an irc bot made by and for the ~#gnulag~ channel on snoonet. It also tries to be usable as a general purpose higher level IRC bot making library, based on the [[https://docs.rs/irc][irc crate]]. + +* Configuration +The main configuration file is ~[[file:config.toml][config.toml]]~ and gets loaded from the current +~$PWD~. The configuration file is using profiles, the ~default~ profile is +loaded as a base. If the binary is compiled in release mode the ~release~ +profile is merged. You can override any variables from ~default~ profile in the +~release~ or ~debug~ profile. If the binary is compiled in debug mode the +~debug~ profile is loaded from ~[[file:config.debug.toml][config.debug.toml]]~. + +All of the settings can also be set using environment variables. The options are +prefixed with ~CATINATOR_~, nested variables are sepperated by ~_~. + +Common environment variables: +- ~CATINATOR_USER_PASSWORD~ +- ~CATINATOR_WA_API_KEY~ + +* Developing & Running +#+begin_src shell +# Compile binary +$ cargo build + +# Run catinator +$ cargo run + +# Run tests +$ cargo test +#+end_src + +** Logging +you can change the log level by setting the ~RUST_LOG~ environment variable. +Available levels are in decreasing verbosity: ~trace~, ~debug~, ~info~, ~warn~, +~error~ |