Skip to content

Commit f1f9c28

Browse files
author
Dominic Mooney
committed
Update readme
1 parent d859b9b commit f1f9c28

File tree

4 files changed

+40
-3
lines changed

4 files changed

+40
-3
lines changed

CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# FM Radio Tuner
22

3+
![Image of fmradio](screens/fmradio.png)
4+
5+
A simple cross-platform Electron app for listening to FM radio using an RTL2832U based USB dongle.
6+
7+
## Features:
8+
- Tested on Windows 10 Windows 7, Ubuntu 16.04 and Fedora 24. Should work on MAC.
9+
- Supports all tuners supported by [rtl-sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr)
10+
- Stereo decoding.
11+
- Good sound quality at higher sample rates (you be the judge).
12+
- Plays audio locally and on local HTTP server for remote listening.
13+
- Scan for stations.
14+
- Add station presets.
15+
- Record audio in lossless FLAC format.
16+
- Fully configurable.
17+
- Prebuilt for x64 Windows and Linux.
18+
19+
## Hardware Requirements
20+
### Intel CPUs
21+
- Dual core CPU (tested and runs on a 2008 Pentium dual core T4200 laptop).
22+
- 1.5GB RAM.
23+
- Max sample rate for Intel is usually 2.56Msps.
24+
### ARM CPU
25+
- Runs well on ASUS Tinkerboard. Tested using Armbian and TinkerOS. Max stable sample rate is 2.56Msps but will run at higher rates, if unreliably.
26+
- Does not run on Raspberry Pi but should run on any SBC with enough RAM and CPU grunt.
27+
28+
## Building
29+
30+
### Linux
31+
Requires librtlsdr-dev, libusb and libFLAC++-dev.
32+
Install dependencies, clone the repo and run 'npm install', then 'npm start' from the cloned directory.
33+
34+
### Windows
35+
Complicated and a little painful. Will document at some point.
36+
37+
38+

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"start": "electron-forge start",
88
"package": "electron-forge package",
99
"make": "electron-forge make",
10+
"publish": "electron-forge publish",
1011
"lint": "eslint app/src --color"
1112
},
1213
"author": "Dominic Mooney",
@@ -60,6 +61,7 @@
6061
"ignore": [
6162
"build_scripts",
6263
"dll_bundle",
64+
"screens",
6365
".vscode",
6466
".npmrc"
6567
],
@@ -78,8 +80,8 @@
7880
"icon": "icons/tower.png"
7981
},
8082
"github_repository": {
81-
"owner": "",
82-
"name": ""
83+
"owner": "dmooney65",
84+
"name": "fmradio"
8385
},
8486
"windowsStoreConfig": {
8587
"packageName": "fmradio"

screens/fmradio.png

45.5 KB
Loading

0 commit comments

Comments
 (0)