FreeTRX/website/home.md
Marcus Kida 35ba6e9975 docs: add MkDocs Material documentation website
Renders the root markdown (manual, tools, changelog) into a static, searchable
HTML site with client-side (lunr.js) search and a dark/light theme. Built in
Docker via website/build-docs.sh (no host installs). Public URL is set at build
time with SITE_URL=... (default is a neutral placeholder; the site works at any
URL since site_url only affects the sitemap/canonical links). Generated output
(website/_build/) is gitignored.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-10 13:29:29 +02:00

35 lines
1.3 KiB
Markdown

# FreeTRX
**FreeTRX** is a fork of the [OpenGD77](https://opengd77.org) firmware for the
**TYT MD-UV380 / Retevis RT-3S** and **Baofeng DM-1701 / Retevis RT-84**.
[Latest release :material-download:](https://git.dk1da.de/DK1DA/FreeTRX/releases){ .md-button .md-button--primary }
[Source :material-git:](https://git.dk1da.de/DK1DA/FreeTRX){ .md-button }
## Screenshots
<div class="grid cards" markdown>
![DMR call with the segmented S-meter](images/screenshot-dmr.png)
![VFO with the 7-segment frequency font](images/screenshot-vfo.png)
</div>
## Documentation
- **[User Manual](MANUAL.md)** — every feature, tagged 🟢 **FreeTRX** (new/changed)
or ⚪ **OpenGD77** (inherited), with a button reference.
- **[Building & Flashing](TOOLS.md)** — Docker build, the flash helper, screenshots.
- **[Changelog](CHANGELOG.md)** — version history.
## Supported radios
Developed and tested on the **TYT MD-UV380 / Retevis RT-3S**. A DM-1701 / RT-84
build is also produced but not yet officially tested. Want to help test another
OpenGD77-supported radio? Email **Marcus, DK1DA** at
[qsl@dk1da.de](mailto:qsl@dk1da.de).
!!! note "License"
FreeTRX inherits the OpenGD77 license (modified BSD 3-Clause with a
non-commercial clause). It is not GPL-compatible and cannot be relicensed.