From 61309d9b57b1c0435b5fb4002ec2f1b65fc0ce53 Mon Sep 17 00:00:00 2001
From: Yoel Bassin <joel@Mac-2.lan>
Date: Fri, 25 Apr 2025 16:39:51 +0300
Subject: [PATCH] main - feat: Create inital README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..610ec05
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# GNURadio MCP Server
+The goal of this project is allowing LLMs to create GNURadio Flowcharts for GNURadio Companion.
+
+## Installation
+
+Install GNURadio, follow the installation process in [InstallingGR](https://wiki.gnuradio.org/index.php/InstallingGR).
+```bash
+brew install gnuradio
+```
+Now create a virtual environment to run the project. 
+```bash
+python3.13 -m venv --system-site-packages venv
+source venv/bin/activate
+pip install -e .
+```
+we use the `--system-site-packages` flag since GNURadio installs the `gnuradio` python package globally. 
+
+Run using 
+```bash
+python -m grc
+```
+
+## Current Status
+Currently, the project is only a port of GNURadio Companion (v3.10.12.0)
\ No newline at end of file