From 1da1e22553e7efae55a4dd137645677d7baef0a9 Mon Sep 17 00:00:00 2001
From: Roman Zeyde <roman.zeyde@gmail.com>
Date: Thu, 23 Oct 2014 16:28:09 +0300
Subject: [PATCH] README: elaborate installation

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c3c7f8d..9f15ca7 100644
--- a/README.md
+++ b/README.md
@@ -33,13 +33,48 @@ A simple CRC-32 checksum is used for data integrity verification on each 1KB dat
 
 # Installation
 
+## via git (for developers)
+
+Make sure that `numpy` and `bitarray` Python packages are installed.
+
+    $ sudo pip install numpy bitarray
+
+Clone and setup relevant path variables:
+
+    $ git clone https://github.com/romanz/amodem.git
+    $ cd amodem
+    $ export PYTHONPATH=`pwd`
+    $ export PATH=$PATH:`pwd`/scripts
+
+## via pip (for users)
+
 Run the following command (will also download and install `numpy` and `bitarray` packages):
 
-	$ sudo pip install amodem
+    $ sudo pip install amodem
 
 For graphs and visualization (optional), install:
 
-	$ sudo pip install matplotlib
+    $ sudo pip install matplotlib
+
+## validation
+
+Run:
+
+    $ amodem -h
+    usage: amodem [-h] [-v | -q] {send,recv} ...
+
+    Audio OFDM MODEM: 48.0 kb/s (64-QAM x 8 carriers) Fs=32.0 kHz
+
+    positional arguments:
+      {send,recv}
+        send         modulate binary data into audio signal.
+        recv         demodulate audio signal into binary data.
+
+    optional arguments:
+      -h, --help     show this help message and exit
+      -v, --verbose
+      -q, --quiet
+
 
 # Calibration