pnmixer-rust/README.md

57 lines
1.9 KiB
Markdown
Raw Normal View History

2017-09-01 23:50:52 +00:00
[![Latest Version](https://img.shields.io/crates/v/pnmixer-rs.svg)](https://crates.io/crates/pnmixer-rs)
2017-07-12 21:51:32 +00:00
[![Build Status](https://travis-ci.org/hasufell/pnmixer-rust.svg)](https://travis-ci.org/hasufell/pnmixer-rust)
2017-07-12 21:50:20 +00:00
[![Join the chat at https://gitter.im/hasufell/pnmixer-rust](https://badges.gitter.im/hasufell/pnmixer-rust.svg)](https://gitter.im/hasufell/pnmixer-rust?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2017-07-14 23:35:17 +00:00
[![Documentation (master)](https://img.shields.io/badge/documentation-master-yellow.svg)](https://hasufell.github.io/pnmixer-rust/pnmixerlib/)
2017-07-12 21:50:31 +00:00
[![License](https://img.shields.io/github/license/hasufell/pnmixer-rust.svg)](https://github.com/hasufell/pnmixer-rust)
2017-07-12 21:50:20 +00:00
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
```
2017-07-16 21:08:40 +00:00
Features/Differences
2017-06-26 07:08:37 +00:00
--------
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
2017-07-16 21:08:40 +00:00
* gtk+:2 support
2017-06-26 07:08:37 +00:00
2017-07-16 21:08:40 +00:00
Differences:
2017-06-26 07:08:37 +00:00
* volume slider is shown even when volume is muted
TODO
2017-07-13 22:26:00 +00:00
----
- [x] [hotkey support](https://github.com/hasufell/pnmixer-rust/issues/5)
2017-07-13 22:26:00 +00:00
- [ ] [translation](https://github.com/hasufell/pnmixer-rust/issues/4)
2017-07-14 23:38:07 +00:00
- [X] [documentation](https://github.com/hasufell/pnmixer-rust/issues/3)
2017-07-19 00:24:39 +00:00
- [ ] [PulseAudio support](https://github.com/hasufell/pnmixer-rust/issues/11)