From 21315bd773ddfa356db3f3cfc5371adba993e0f0 Mon Sep 17 00:00:00 2001
From: DJ2LS <75909252+DJ2LS@users.noreply.github.com>
Date: Sat, 12 Dec 2020 20:07:38 +0100
Subject: [PATCH] Update README.md

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2a256ce1..0d417388 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,34 @@
 # FreeDV-Socket-TNC
-
 My first attempt to learn more about FreeDV and how to create a TNC which gets data from a TCP/IP Socket.
 
+## Setup
+
+sudo apt install portaudio19-dev
+
+
+## Run
+./__main__.py --rx-sound-device 2 --tx-sound-device 2 --port 3000
+
+## Parameters
+--rx-sound-device <1>
+--tx-sound-device <1>
+--port <3000>
+
+To list all audio devices run 
+./__main__.py --list-audio-devices
+
+
+## Socket Commands
+
+BC:<DATA>    Send a simple broadcast
+
+
+
+
+##Credits
+
+David Rowe and the FreeDV team for developing the modem and libraries
+FreeDV Codec 2 : https://github.com/drowe67/codec2
+
 
 This software has been heavily inspired by https://github.com/xssfox/freedv-tnc/