From dc346497d0c8934f79029dbc4bc2136516c0d869 Mon Sep 17 00:00:00 2001 From: Silvano Seva Date: Thu, 7 Oct 2021 21:15:19 +0200 Subject: [PATCH] Updated readme --- README.md | 41 ++++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 34e88372..afbb795b 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,26 @@ with modularity, flexibility and performance in mind. Currently OpenRTX is being actively developed for the following radios: -- TYT MD-380/390 **UHF versions only** +- TYT MD-380/390 - TYT MD-UV380/390 - TYT MD-9600 -- Radioddity GD77 +- Radioddity GD77 and Baofeng DM-1801 -This firmware is *highly experimental* and is not in a usable state right now, -however contributions and testing are welcome and accepted. +This firmware is *highly experimental* and currently under development, this means +that it may not have all the expected functionalities. Contributions and testing +are anyway warmly welcome and accepted! For information on currently supported radios and features, see the [Supported Platforms](https://openrtx.org/#/platforms) page on our website. For hardware and software documentation visit [openrtx.org](https://openrtx.org/) -**WARNING: DO NOT flash the OpenRTX firmware on an MD-380V(G) or MD-390V(G)! The codebase has not been fully tested on these devices.** +## Compiling and flashing + +**Warning: read the Disclaimer section first!** + +For instructions on how to compile and flash OpenRTX to your radio, +or just run OpenRTX on Linux see the [Compilation instructions](https://openrtx.org/#/compiling) page on our website. -## Flash on MD-3x0 and MD-UV3x0 On TYT MD-3x0 and MD-UV3x0 you can flash our firmware using tarxvf's web based flashing tool. @@ -31,10 +36,22 @@ On TYT MD-3x0 and MD-UV3x0 you can flash our firmware using tarxvf's web based f - Click on "Choose File", select the latest OpenRTX release you downloaded before, and click on "Upgrade Radio". - Reboot your radio -## Compile and flash -For instructions on how to compile and flash OpenRTX to your radio, -or just run OpenRTX on Linux see the [Compilation instructions](https://openrtx.org/#/compiling) page on our website. +If you want to try the latest available firmware and you do not want to go +through all the compilation process, Phil DF5PMF kindly provides nightly builds +of the master branch [here](https://openrtx.schinken-radio.de/nightly/). + +## Disclaimer + +This project was created for research and amateur radio use only, we are not +responsible for improper uses of this code which might lead to unauthorized +transmission, reception or patent infringments. + +The OpenRTX firmware is released WITHOUT ANY WARRANTY: anyone flashing a binary +image obtained from the sources made available through this repository does it +at its own risk. We always test all the code on our devices before publishing it +on the repository, however we cannot guarantee the absolute absence of bugs and +potential side effects. ## Screenshots @@ -56,12 +73,6 @@ minmea is released under the DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE v2. Code for STM32F405 USB driver is released under the MCD-ST Liberty SW License Agreement V2. -## Disclaimer - -This project was created for research and amateur radio use only, -we are not responsible for improper uses of this code which might lead to -unauthorized transmission, reception or patent infringments. - ## Credits OpenRTX was created by: