From ef6cb4b740a94e200a03527852302878e8bdab2c Mon Sep 17 00:00:00 2001 From: Roman Zeyde Date: Fri, 1 Aug 2014 11:44:49 +0300 Subject: [PATCH] Fix README.md --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ccb944d..565924e 100644 --- a/README.md +++ b/README.md @@ -38,27 +38,36 @@ Make sure that `numpy` and `reedsolo` Python packages are installed. Connect the audio cable between the sender and the receiver, and run the following script on both of them. - $ ./auto-calib.sh +``` +$ ./calib.py send # run on the sender side +$ ./calib.py recv # run on the receiver side +``` The sender computer's audio level should be increased, until the received -amplitude is around 0.5, while the coherence is very close to 1.0 (so no -saturation takes place). +**amplitude** is not higher than 0.5, while the **coherence** is 1.0 (so +saturation does not happen). ## Testing -`test.sh` script is used to transmit a random data file between two computers, -using SSH connection, and to verify its correct reception. +`test.sh` script is used to transmit a random data file between two computers +(using SSH connection) and to verify its correct reception. - Set connection parameters to sending computer: - $ export SRC_HOST="sender@tx.host" - $ export SRC_DIR="/home/sender/Code/amodem" +``` +$ export SRC_HOST="sender@tx.host" +$ export SRC_DIR="/home/sender/Code/amodem" +``` - Set connection parameters to receiving computer: - $ export DST_HOST="receiver@rx.host" - $ export SRC_DIR="/home/receiver/Code/amodem" +``` +$ export DST_HOST="receiver@rx.host" +$ export SRC_DIR="/home/receiver/Code/amodem" +``` - Run the test script: - $ ./test.sh +``` +$ ./test.sh +```