Skip to content

Commit

Permalink
updating README.md and moving man page out of pyradio/
Browse files Browse the repository at this point in the history
  • Loading branch information
s-n-g committed Nov 26, 2018
1 parent cb6fcc7 commit 83293a8
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ dist
build
.vimrc
*.log
*.sh
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,28 @@ The second step is to install the build:

## Shell commands

$ pyradio -h

usage: main.py [--help] [--stations <path>] [--random] [--add] [--list]

Console radio player

optional arguments:
-s, --stations <path> Use specified station CSV file.
-p, --play [play] Start and play. The value is num station or empty for random.
-a, --add Add station to list.
-l, --list List of added stations.
-u, --use-player Specify which player to use (mpv, mplayer or cvlc).
-d, --debug Debug mode (pyradio.log created).
To be attached with any bug report.
-h, --help Show this help message and exit.
```
$ pyradio -h
usage: pyradio [-h] [-s STATIONS] [-p [PLAY]] [-a] [-l] [-d] [-u USE_PLAYER]
Curses based Internet radio player
optional arguments:
-h, --help show this help message and exit
-s STATIONS, --stations STATIONS
Use specified station CSV file.
-p [PLAY], --play [PLAY]
Start and play.The value is num station or empty for
random.
-a, --add Add station to list.
-l, --list List of added stations.
-d, --debug Start pyradio in debug mode.
-u USE_PLAYER, --use-player USE_PLAYER
Use specified player. A comma-separated list can be
used to specify detection order. Supported players:
mpv, mplayer, vlc.
```

## Controls

Expand Down
File renamed without changes.

0 comments on commit 83293a8

Please sign in to comment.