mirror of
https://github.com/figsoda/mmtc
synced 2024-11-10 10:14:13 +00:00
add building instructions, usage and changelog
This commit is contained in:
parent
6cac3953ee
commit
27ab5986ab
1 changed files with 40 additions and 0 deletions
40
README.md
40
README.md
|
@ -1,2 +1,42 @@
|
|||
# mmtc
|
||||
|
||||
Minimal mpd terminal client
|
||||
|
||||
|
||||
## Building from source
|
||||
|
||||
This requires the nightly toolchain of Rust.
|
||||
|
||||
```shell
|
||||
cargo +nightly build --release
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
mmtc [OPTIONS]
|
||||
```
|
||||
|
||||
### FLAGS
|
||||
|
||||
```
|
||||
-h, --help Prints help information
|
||||
-V, --version Prints version information
|
||||
```
|
||||
|
||||
### OPTIONS
|
||||
|
||||
```
|
||||
-a, --address <address> Specify the address of the mpd server
|
||||
-c, --config <config> Specify the config file
|
||||
-c, --cycle <cycle> Cycle through the queue
|
||||
-j, --jump-lines <jump-lines> The number of lines to jump
|
||||
-s, --seek-secs <seek-secs> The time in seconds to seek
|
||||
-u, --ups <ups> The amount of status updates per second
|
||||
```
|
||||
|
||||
|
||||
## Changelog
|
||||
|
||||
See [CHANGELOG.md](https://github.com/figsoda/mmtc/blob/main/CHANGELOG.md)
|
||||
|
|
Loading…
Reference in a new issue