Skip to content

Commit 83293a8

Browse files
committed
updating README.md and moving man page out of pyradio/
1 parent cb6fcc7 commit 83293a8

File tree

3 files changed

+23
-15
lines changed

3 files changed

+23
-15
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ dist
66
build
77
.vimrc
88
*.log
9+
*.sh

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,28 @@ The second step is to install the build:
4949

5050
## Shell commands
5151

52-
$ pyradio -h
53-
54-
usage: main.py [--help] [--stations <path>] [--random] [--add] [--list]
55-
56-
Console radio player
57-
58-
optional arguments:
59-
-s, --stations <path> Use specified station CSV file.
60-
-p, --play [play] Start and play. The value is num station or empty for random.
61-
-a, --add Add station to list.
62-
-l, --list List of added stations.
63-
-u, --use-player Specify which player to use (mpv, mplayer or cvlc).
64-
-d, --debug Debug mode (pyradio.log created).
65-
To be attached with any bug report.
66-
-h, --help Show this help message and exit.
52+
```
53+
$ pyradio -h
54+
55+
usage: pyradio [-h] [-s STATIONS] [-p [PLAY]] [-a] [-l] [-d] [-u USE_PLAYER]
56+
57+
Curses based Internet radio player
58+
59+
optional arguments:
60+
-h, --help show this help message and exit
61+
-s STATIONS, --stations STATIONS
62+
Use specified station CSV file.
63+
-p [PLAY], --play [PLAY]
64+
Start and play.The value is num station or empty for
65+
random.
66+
-a, --add Add station to list.
67+
-l, --list List of added stations.
68+
-d, --debug Start pyradio in debug mode.
69+
-u USE_PLAYER, --use-player USE_PLAYER
70+
Use specified player. A comma-separated list can be
71+
used to specify detection order. Supported players:
72+
mpv, mplayer, vlc.
73+
```
6774

6875
## Controls
6976

File renamed without changes.

0 commit comments

Comments
 (0)