From 63695021db135859818c7ddbfd2a9a66e1bcb8aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Mon, 16 Nov 2020 13:12:53 +0100 Subject: add note about features and libsamplerate --- README.org | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'README.org') diff --git a/README.org b/README.org index 8dcebee..a055786 100644 --- a/README.org +++ b/README.org @@ -13,6 +13,8 @@ and operating systems, or they might be named something different. - `alsa-lib` - `openssl` - `opus` +- `libnotify` (optional) +- `libsamplerate` (optional) Windows is not currently supported but could be in the future. macOS should work. Other operating systems haven't been tested. The limiting factor on Windows @@ -29,6 +31,35 @@ $ ln -s $PWD/target/release/mumctl $HOME/.local/bin/ $ ln -s $PWD/target/release/mumd $HOME/.local/bin/ #+END_SRC +*** Optional features +`mum` contains optional features that are enabled by default. To compile without +them, build with `--no-default-features`. Features can then be enabled with +`--features "FEATURES"`. + +The following features can be specified: + +| Name | Needed for | Additional crates | +|--------------------+---------------+-------------------| +| mumd/libnotify | Notifications | 20 | +| mumd/libsamplerate | Sound effects | 54 | + +Note that the "additional crates" isn't continually updated and might change. +Features might also have overlapping dependencies. + +Awaiting `-Z package-features`, changing which features are compiled requires +you to compile `mumd/` separately by entering its directory and specifying +its features. + +To summarize with an example, the following compiles with only libnotify +enabled. + +#+BEGIN_SRC sh +$ cd mumd +$ cargo build --release --no-default-features --features "libnotify" +$ cd ../mumctl +$ cargo build --release +#+END_SRC + ** Usage This describes how to connect to a server and join different channels. See usage.org or `$ mumctl --help` for more information. -- cgit v1.2.1