From 2ffaad16ac3e390c88ec6e18b8f10e8cb10f21c6 Mon Sep 17 00:00:00 2001 From: Mark de Bruijn Date: Fri, 26 Sep 2025 08:12:30 +0200 Subject: [PATCH] fix: update readme.md --- README.md | 76 +++++++++++++++++++++++-------------------------------- 1 file changed, 32 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 8f3e07e..da9367c 100644 --- a/README.md +++ b/README.md @@ -2,62 +2,50 @@ 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 the XDR-GTK plugin +## Supported devices + +- **TEF668x:** Supported with PE5PVB's and Konrad's FM-DX Tuner firmware, Arduino versions with other firmwares should work too. +- **XDR F1HD:** Officially supported, works best with Konrad's FM-DX Tuner firmware. +- **SDR (AirSpy / RTL-SDR):** Supported **unofficially** via SDRSharp and the XDR-GTK plugin. ## Features -- **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. + +- **Cross-platform support:** + - Linux + - macOS + - Windows + +- **Web-Based Control:** Access and control your receiver from any device with a web browser. +- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users. + +- **Plugin-support**: See our wiki for summary of available [plugins](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Plugin-List). - **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. -- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users -## Features to be added -Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list +## Getting Started -## Community -Join our **Discord community** to get the latest development update info, share feedback and receive support. -[Join the OpenRadio Discord community!](https://discord.gg/ZAVNdS74mC) - -## Getting Started (Windows) - -1. Install node.js from here: - ```bash - https://nodejs.org/en - ``` - -2. Clone the repository (or alternatively download it manually): - - ```bash - git clone https://github.com/NoobishSVK/FM-DX-Webserver.git - ``` - -3. Navigate to the fm-dx-webserver folder in your terminal/command prompt and run this command: - ```bash - npm install - ``` - -4. Start the server: - - ```bash - npm run webserver - ``` - -5. Open your web browser and navigate to `http:/localhost:8080` to access the web interface. - -## Getting Started (Linux) -[Click here for the Linux installation tutorial.](https://gist.github.com/bkram/788098558312d2fa71c07dc443e03d10) +- [Linux installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Linux-Installation) +- [macOS installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/macOS-Installation) +- [Windows installation](https://github.com/NoobishSVK/fm-dx-webserver/wiki/Windows-Installation) ## Utilized projects This project utilizes these libraries: -- [librdsparser](https://github.com/kkonradpl/librdsparser) library by Konrad Kosmatka for RDS parsing -- [3LAS](https://github.com/jojobond/3LAS) library by JoJoBond for Low Latency Audio Streaming -- [flat-flags](https://github.com/luishdez/flat-flags) library by luishdez for RDS country flags + +- [3LAS](https://github.com/jojobond/3LAS) library by JoJoBond for Low Latency Audio Streaming. +- [flat-flags](https://github.com/luishdez/flat-flags) library by luishdez for RDS country flags. +- [librdsparser](https://github.com/kkonradpl/librdsparser) library by Konrad Kosmatka for RDS parsing. All of these libraries are already bundled with the webserver. +## 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 OpenRadio Discord community!](https://discord.gg/ZAVNdS74mC) + ## Contributing Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable!