Skip to content

Commit dbb75eb

Browse files
committed
Update README
1 parent 9695965 commit dbb75eb

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,29 @@ This is an unofficial Linux client for the Q2 Wi-Fi Internet Radio.
55
It uses libusb for the communication with the device in userspace.
66
This program provides some basic functionality for loading radio stations to each side of the radio.
77

8-
A [windows executable](https://github.com/vporpo/q2radio/releases) can be found in the releases. Please download the zip file containing the windows executable along with the dlls.
8+
A [windows executable](https://github.com/vporpo/q2radio/releases) can be found in the releases. Please download the `q2radio_win.zip` file containing the windows executable along with the dlls and unzip it.
99

10-
## Requirements
10+
## Run examples:
11+
- Linux:
12+
```bash
13+
$ ./q2radio --list # List the current state of the radio
14+
$ ./q2radio --side 0 --name "New Radio" --url "http://stream/url"
15+
$ ./q2radio --wifi-ssid "<SSID>" --wifi-key "<WIFI KEY>"
16+
17+
```
18+
19+
- Windows (command prompt)
20+
```
21+
C:\the\unzipped\q2radio\path\> q2radio.exe --help
22+
```
23+
24+
## Build Instructions
25+
26+
### Dependencies
1127
* libusb: You need to have the libusb developers package (The header file libusb.h is required).
1228
* A c++ compiler
1329
* make
1430

15-
## Build Instructions
1631
```bash
1732
$ git clone https://github.com/vporpo/q2radio.git
1833
$ make -C q2radio/src
@@ -36,10 +51,3 @@ In the Zadig tool click on Options > List All Devices. Then Q2Radio should show
3651
Switch it to the "WinUSB" driver by selecting it on the right hand side of the green arrow, and click on the "Replace Driver" button.
3752
Then try running `q2radio.exe` once again, this time it should work.
3853

39-
## Run examples:
40-
```bash
41-
$ ./q2radio --list # List the current state of the radio
42-
$ ./q2radio --side 0 --name "New Radio" --url "http://stream/url"
43-
$ ./q2radio --wifi-ssid "<SSID>" --wifi-key "<WIFI KEY>"
44-
45-
```

0 commit comments

Comments
 (0)