diff --git a/README.md b/README.md index 3823cab..5f0e670 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,20 @@ ![Python](https://img.shields.io/badge/python-3.8%2B-blue) ![Flask](https://img.shields.io/badge/flask-2.x-orange) -![License](https://img.shields.io/badge/license-MIT-green) -**Gain-Viz** is an interactive SDR (Software Defined Radio) web application that lets you **adjust transmitter/receiver gains** and **visualize the effects in real time**. +# gain-viz + +**gain-viz** is a Python-based web application for adjusting RF gain settings and visualizing their effect in real-time. It integrates with USRP and SCM devices, providing live IQ time-series and spectrum visualization. --- ## Features -- Adjust **USRP Tx/Rx** and **SCM Tx/Rx** gains dynamically. -- Real-time **time-domain IQ visualization**. -- Real-time **spectrum analysis** with fast refresh. -- Automatically maintains last signal if no new data arrives. -- Web-based interface using **Flask**. -- Responsive design for desktop and tablet use. - ---- +- Adjust **USRP Tx/Rx gains** and **SCM Tx/Rx gains** from a web interface. +- Live IQ **time-series plot** in milliseconds. +- Live **spectrum visualization** (waterfall / spectrogram). +- Fast refresh for near real-time feedback. +- Responsive and clean web interface built with HTML/CSS/JS. @@ -29,9 +27,11 @@ Make sure you have **Python 3.8+** installed. ```bash git clone https://github.com/yourusername/gain-viz.git -cd gain-viz ``` +cd gain-viz +``` 2. Build and install + ```bash pip install --upgrade build python -m build