From e5615d93fde8604caefc083f30c7cf43127b57e0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rog=C3=A9rio=20Andrella?=
 <rogerioandrella24081990@gmail.com>
Date: Mon, 20 Jul 2026 20:45:19 -0300
Subject: [PATCH] add readme and requirements.txt

---
 .gitignore       |  1 +
 README.md        | 19 +++++++++++++++++++
 requirements.txt |  2 ++
 3 files changed, 22 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md
 create mode 100644 requirements.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..eba74f4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+venv/
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6366016
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# transmit data over sound
+
+## setup
+after cloning this repository, is recommended to create a virtual environment to install the needed packages:
+`python3 -m venv venv`
+on mac/linux:
+`source venv/bin/activate`
+on windows:
+`venv\Scripts\activate`
+now you can install the requirements:
+`python3 -m pip install -r requirements.txt`
+
+## transmit data
+edit the line 9 of transmissor.py file, replacing the string that you want to transmit:
+`payload =  b"Hello World!"`
+and run transmissor.py, it will generate the noise of data, you can record it externally
+
+## decode data
+run receptor.py, it will stay hearing the built in microphone and decode all heared data
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..4ec83d3
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+ggwave==0.4.3
+PyAudio==0.2.14