pnmixer-rust/README.md

54 lines
990 B
Markdown
Raw Normal View History

2017-06-26 07:08:37 +00:00
PNMixer-rs
==========
About
-----
Rewrite of [nicklan/pnmixer](https://github.com/nicklan/pnmixer) in
[Rust](https://www.rust-lang.org).
This is meant as a drop-in replacement, but may diverge in feature set
in the future.
Installation
------------
The Rust ecosystem uses [Cargo](https://crates.io/), as such, you need
both the rust compiler and the cargo crate
(usually part of the compiler toolchain), then issue from within
the cloned repository:
```sh
cargo install
```
Features
--------
Additonal features compared to [nicklan/pnmixer](https://github.com/nicklan/pnmixer):
* decide whether to unmute or not on explicit volume change
* updates tray icon on icon theme change
Removed features:
* normalize volume
* slider orientation of volume popup
* settings for displaying text volume on volume popup
TODO:
* hotkey support
Behavior
--------
Pretty much the same. Differences are:
* volume slider is shown even when volume is muted
Documentation
-------------
TODO