From 39f0db35c27efdcd4a5e475f368faf55ecb2ec6c Mon Sep 17 00:00:00 2001 From: NoobishSVK Date: Thu, 21 Mar 2024 22:50:46 +0100 Subject: [PATCH] readme update --- README.md | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 078faa8..181e639 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ # FM-DX Webserver 📻🌐 -FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their TEF6686 / F1HD receiver through a web interface. +FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their radio receiver through a web interface. + +# Officially supported devices +- **TEF668x:** Supported with PE5PVB's and Konrad's FM-DX Tuner firmware, although Arduino versions with other firmwares will work too +- **XDR F1HD:** Officially supported, works best with Konrad's FM-DX Tuner firmware +- **SDR (AirSpy / RTL-SDR):** Supported unofficially via SDRSharp and XDR-GTK plugin ## Features - -- 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. -- 📻 **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface. +- **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. +- **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface. - **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd. -- **Tuner control:** Control your FM tuner on the go. Phone? Tablet? No problem. - **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users -## Features to be added +## Features to be added Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list ## Community Join our **Discord community** to get the latest development update info, share feedback and receive support. -[Join the TEF6686 Discord community!](https://discord.gg/ZAVNdS74mC) +[Join the OpenRadio Discord community!](https://discord.gg/ZAVNdS74mC) ## Getting Started @@ -24,23 +27,12 @@ Join our **Discord community** to get the latest development update info, share https://nodejs.org/en ``` -1. Clone the repository (or alternatively download it manually): +2. Clone the repository (or alternatively download it manually): ```bash git clone https://github.com/NoobishSVK/FM-DX-Webserver.git ``` -2. Download or install ffmpeg (optional, but needed if you want the audio stream to work) - - ```bash - Linux (Ubuntu/Debian): - sudo apt install ffmpeg - - Windows: - Download this file: https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-essentials.7z - Extract the file bin/ffmpeg.exe into the fm-dx-webserver folder - ``` - 3. Navigate to the fm-dx-webserver folder in your terminal/command prompt and run this command: ```bash npm install