Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielSchuette committed Jun 1, 2019
1 parent 0136633 commit a41d8c2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ Audio playback uses [mpv](http://mpv.io/). `Curseradio-improved` requires `pytho
Install the module from `PyPI`:
```bash
pip3 install curseradio-improved
curseradio-improved # tests the success installation
```

You can also install `curseradio-improved` by downloading the source code (or cloning this repository) and typing:
You can also install `curseradio-improved` from source by cloning (or downloading the code from) this repository. Then type:
```bash
make # might prompt for `sudo' password
make test # tests the success installation
curseradio-improved # tests the success installation
```

## Settings
Expand All @@ -34,12 +35,12 @@ You can use the keys below to navigate and select things in the `tui`. `vi`-like
Key(s) | Command
-----------------------------------------------------------------|--------------------------------
<kbd>↑</kbd> or <kbd>k</kbd>, <kbd>↓</kbd> or <kbd>j</kbd> | navigate
<kbd>PgUp</kbd> or <kbd>p</kbd>, <kbd>PgDn</kbd> or <kbd>n</kbd> | navigate quickly
<kbd>PgUp</kbd> or <kbd>p</kbd>, <kbd>PgDn</kbd> or <kbd>n</kbd> | navigate inbetween sections
<kbd>Home</kbd> or <kbd>g</kbd>, <kbd>End</kbd> or <kbd>G</kbd> | to top/bottom
<kbd>Enter</kbd> | open/close folders, play stream
<kbd>s</kbd> | stop playing stream
<kbd>q</kbd> | quit
<kbd>f</kbd> | toggle favourite

## License
`Curseradio-improved` is MIT-licensed (see [LICENSE.md](./LICENSE.md)).
`curseradio-improved` is MIT-licensed (see [LICENSE.md](./LICENSE.md)).

0 comments on commit a41d8c2

Please sign in to comment.