Skip to content

Commit f9fce10

Browse files
authored
adding missing qml packages to README.md
- fixes #823 - some minor grammar or typo fixes
1 parent fbf753b commit f9fce10

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
This repository contains the implementation of an SDR DAB/DAB+ receiver.
88
Please see the project website https://www.welle.io for a user oriented documentation.
99

10-
welle.io is a fork from dab-rpi and sdr-j-dab which is now qt-dab https://github.com/JvanKatwijk/qt-dab.
10+
welle.io is a fork from dab-rpi and sdr-j-dab which is now qt-dab (see https://github.com/JvanKatwijk/qt-dab ).
1111

1212
Table of contents
1313
====
@@ -94,7 +94,7 @@ Ctrl+Down, Volume Down | Volume Down
9494
Supported Hardware
9595
====================
9696
The following SDR devices are supported
97-
* Airspy R2 and Airspy Mini (http://airspy.com/)
97+
* Airspy R2 and Airspy Mini (http://airspy.com/); remark: Airspy HF+ is not supported due to limited bandwidth
9898
* rtl-sdr (http://osmocom.org/projects/sdr/wiki/rtl-sdr)
9999
* rtl_tcp (http://osmocom.org/projects/sdr/wiki/rtl-sdr#rtl_tcp)
100100
* I/Q RAW file (https://www.welle.io/devices/rawfile)
@@ -147,7 +147,7 @@ sudo apt install libfaad-dev libmpg123-dev libfftw3-dev librtlsdr-dev libusb-1.0
147147
3. Install the following Qt packages
148148

149149
```
150-
sudo apt install libqt6charts6-dev qt6-base-dev qt6-tools-dev-tools qt6-multimedia-dev qt6-wayland-dev libqt6core5compat6-dev libqt63dquick6 libqt6qml6 qt6-declarative-dev qml6-module-qtquick-controls qml6-module-qtquick qml6-module-qt5compat-graphicaleffects qml6-module-qtcharts qml6-module-qtmultimedia qml6-module-qtquick-window qml6-module-qtquick-layouts qml6-module-qtqml-workerscript qml6-module-qtwayland-compositor qml6-module-qtquick-templates qtcreator
150+
sudo apt install libqt6charts6-dev qt6-base-dev qt6-tools-dev-tools qt6-multimedia-dev qt6-wayland-dev libqt6core5compat6-dev libqt63dquick6 libqt6qml6 qt6-declarative-dev qml6-module-qtquick-controls qml6-module-qtquick qml6-module-qt5compat-graphicaleffects qml6-module-qtcharts qml6-module-qtmultimedia qml6-module-qtquick-window qml6-module-qtquick-layouts qml6-module-qtqml-workerscript qml6-module-qtwayland-compositor qml6-module-qtquick-templates qtcreator qml6-module-qtcore qml6-module-qtquick-dialogs qml6-module-qtquick-dialogs
151151
```
152152

153153
4. Clone welle.io
@@ -164,7 +164,7 @@ Windows 10 / 11
164164
---
165165
A compiled version can be found at the [release page](https://github.com/AlbrechtL/welle.io/releases)
166166

167-
This sections shows how to compile welle.io on Windows 10. Windows 7 should also be possible but is not tested.
167+
This section shows how to compile welle.io on Windows 10. Windows 7 should also be possible but is not tested.
168168

169169
1. Install Qt 6.2 (MinGW 64-bit) or newer including "Qt Charts" and "Qt 5 Compatibility Module" modules by using the "Qt Online Installer for Windows" https://www.qt.io/download-open-source/
170170
2. Clone welle.io https://github.com/AlbrechtL/welle.io.git e.g. by using [TortoiseGit](https://tortoisegit.org).
@@ -177,7 +177,7 @@ macOS
177177
---
178178
**WARNING: Not tested with Qt 6.2!**
179179

180-
To build for macOS, you have have several options: Either you install everything incl. dependencies manually (not covered here and not recommended) or use Homebrew or MacPorts.
180+
To build for macOS, you have several options: Either you install everything incl. dependencies manually (not covered here and not recommended) or use Homebrew or MacPorts.
181181

182182
### Homebrew
183183

@@ -197,25 +197,28 @@ brew install AlbrechtL/welle_io/welle.io
197197

198198
### MacPorts
199199

200-
You can either use the welle.io port available in macports, or compile with QT Creator.
200+
You can either use the welle.io port available in macports, or compile with Qt Creator.
201201

202202
#### use welle.io port
203203

204204
This is the easiest way and will manage the dependencies for you.
205205
Variants enabled by default are : "airspy" "rtlsdr" "soapysdr". Each enables compilation with that specific input device library.
206+
206207
```
207208
sudo port install welle.io
208209
```
209-
Additional variants are : "cli" (to install also welle-cli) "profiling" & "kiss_fft".
210+
211+
Additional variants are: "cli" (to install also welle-cli) "profiling" & "kiss_fft".
210212

211213
With MacPorts, welle.io is installed as a bundle app in `/Applications/MacPorts`.
212214

213215
You can also use welle.io-devel port if you prefer:
216+
214217
```
215218
sudo port install welle.io-devel
216219
```
217220

218-
#### compile with QT Creator
221+
#### compile with Qt Creator
219222

220223
You need to install the dependencies with MacPorts first, assuming you have [MacPorts](https://www.macports.org/) installed:
221224

@@ -230,7 +233,7 @@ sudo port install fftw-3-single faad2 rtl-sdr libusb mpg123 lame
230233
git clone https://github.com/AlbrechtL/welle.io.git
231234
```
232235

233-
3. Open welle.io.pro with Qt Creator.
236+
3. Open `welle.io.pro` with Qt Creator.
234237
4. Make sure in Qt Creator, "Projects, Build&Run, Run" that the checkbox "Add build library path to DYLD..." is off.
235238
5. Build and run.
236239

@@ -306,7 +309,7 @@ welle.io uses the "RTL2832U driver" from Martin Marinov, to be found at the [Goo
306309
This sections shows how to compile welle.io for Android.
307310

308311
1. Install Qt 5.12 for Android including the Qt Charts and Qt Remote Objects modules by using the "Qt Online Installer for Windows" https://www.qt.io/download-open-source/
309-
2. Follow the side https://doc.qt.io/qt-5/androidgs.html to install the Android build environment
312+
2. Follow the site https://doc.qt.io/qt-5/androidgs.html to install the Android build environment
310313
3. Clone welle.io https://github.com/AlbrechtL/welle.io.git
311314

312315
```
@@ -327,28 +330,28 @@ Usage of welle-cli
327330

328331
Receive using RTLSDR, and play with ALSA:
329332

330-
welle-cli -c channel -p programme
333+
`welle-cli -c channel -p programme`
331334

332335
Read an IQ file and play with ALSA: (IQ file format is u8, unless the file ends with FORMAT.iq)
333336

334-
welle-cli -f file -p programme
337+
`welle-cli -f file -p programme`
335338

336339
Use -D to dump FIC and all programmes to files:
337340

338-
welle-cli -c channel -D
341+
`welle-cli -c channel -D`
339342

340343
Use -w to enable webserver, decode a programme on demand:
341344

342-
welle-cli -c channel -w port
345+
`welle-cli -c channel -w port`
343346

344347
Use -Dw to enable webserver, decode all programmes:
345348

346-
welle-cli -c channel -Dw port
349+
`welle-cli -c channel -Dw port`
347350

348351
Use `-C 1 -w` to enable webserver, decode programmes one by one in a carousel.
349352
Use `-C N -w` to enable webserver, decode programmes N by N in a carousel.
350353
This is useful if your machine cannot decode all programmes simultaneously, but you still want to get an overview of the ensemble.
351-
By default welle-cli will switch every 10 seconds.
354+
By default, welle-cli will switch every 10 seconds.
352355
With the `-P` option, welle-cli will switch once DLS and a slide were decoded, staying at most for 80 seconds on a given programme.
353356

354357
welle-cli -c channel -C 1 -w port
@@ -375,7 +378,7 @@ Driver options
375378
By default, `welle-cli` tries all enabled drivers in turn and uses the first device it can successfully open.
376379

377380
Use `-F [driver][,driver_args]` to select a specific driver and optionally pass arguments to the driver.
378-
This allows to select the `rtl_tcp` driver (which is not autodetected) and pass the hostname or IP address and port of the rtl_tcp server to it:
381+
This allows to select the `rtl_tcp` driver (which is not auto-detected) and pass the hostname or IP address and port of the rtl_tcp server to it:
379382

380383
welle-cli -C 10B -p GRRIF -F rtl_tcp,192.168.12.34:1234
381384
welle-cli -C 10B -P GRRIF -F rtl_tcp,my.rtl-tcp.local:9876

0 commit comments

Comments
 (0)