From 09a3d57adc20c497b9b7512e8822dab03c4e589f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Hamal=20Dvo=C5=99=C3=A1k?= <mordae@anilinux.org>
Date: Tue, 4 Jun 2024 19:27:58 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a4faca1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Pico SDR
+
+Using RP2040 / Raspberry Pi Pico as a software-defined radio receiver.
+
+1. Clone using `git clone --recursive` as this package is using a custom USB
+   stdio library for better throughput and to avoid deadlocks.
+
+2. Build and flash the firmware as usual:
+
+   ```bash
+   export PICO_SDK_PATH=/path/to/pico-sdk
+   cmake -B build src
+   cmake --build build
+   picotool load -f build/pico_sdr.uf2
+   ```
+
+3. Start the USB serial to TCP bridge, setting the frequency to 88.2 MHz:
+
+   ```bash
+   python util/bridge.py -f 88200000
+   ```
+
+4. Open `grc/PicoSDR-WBFM.grc` in GNU Radio Companion.
+
+5. Press `F6`.