diff --git a/README.md b/README.md index 047e20c..5c7c293 100644 --- a/README.md +++ b/README.md @@ -18,45 +18,46 @@ Join our **Discord community** to get the latest development update info, share [Join the TEF6686 Discord community!](https://discord.gg/ZAVNdS74mC) ## Getting Started -Please install **node.js version 21.5.0** or older to make this work. -Version >=21.6.0 is currently not working correctly. +1. Install node.js from here: + ```bash + https://nodejs.org/en + ``` +1. Clone the repository (or alternatively download it manually): + ```bash + git clone https://github.com/NoobishSVK/FM-DX-Webserver.git + ``` -1. Download or install ffmpeg (optional, but needed if you want the audio stream to work) +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: - https://www.geeksforgeeks.org/how-to-install-ffmpeg-on-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 ``` -2. Clone the repository (or alternatively download it manually): - - ```bash - git clone https://github.com/NoobishSVK/FM-DX-Webserver.git - ``` - -3. Nagivate to the fm-dx-webserver folder in your terminal and run this command: +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 ``` -4. Open your web browser and navigate to `http://web-server-ip:web-server-port` to access the web interface. +5. Open your web browser and navigate to `http:/localhost:8080` to access the web interface. ## Dependencies This project utilizes the [librdsparser](https://github.com/kkonradpl/librdsparser) library for RDS parsing. Make sure to check out the library for more information. +Pre-built version of this library is bundled with the webserver. ## Contributing @@ -66,8 +67,4 @@ Feel free to contribute to the project by opening issues or submitting pull requ This project is licensed under the [GNU-GPL v3 License](LICENSE.md). -## Acknowledgments - -- Thanks to [librdsparser](https://github.com/kkonradpl/librdsparser) for providing the RDS parsing functionality. - Happy DXing! πŸŽΆπŸ“‘