diff --git a/README.md b/README.md index 95de8b09e07498e0b6bcf0c0e7b82615d185e8ea..dcaa03b1761a9691e3cd3b05043a58a09d241f72 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -# LiFiBenchMarkingNetwork - -Test harness for LiFi network evaluation. Java application(s) to run on both ends of a network link to measure data transfer rates. - -Online at https://gitlab.nps.edu/Savage/LiFiGroup/LiFiBenchMarkingNetwork - - -## Operation - -Run ant task _jar_ to create a jar with libs included which will also copy -scripts to the dist folder for invocation via CLI - -Invoke the server script first (will run approx. 10 seconds) before invoking any -other "read" scripts - -The "error" thrown by the read*.sh is because a buffer array is only alloted a -certain size upon creation which then throws an overflow error (harmless) +# LiFiBenchMarkingNetwork + +Test harness for LiFi network evaluation. Java application(s) to run on both ends of a network link to measure data transfer rates. + +Online at https://gitlab.nps.edu/Savage/LiFiGroup/LiFiBenchMarkingNetwork + + +## Operation + +1. Run ant task _jar_ to create a jar with libs included which will also copy +scripts to the dist folder for invocation via CLI. + +2. Go to runscripts directory to invoke shell scripts + +3. Invoke the server script first (will run approx. 30 seconds) before invoking any +other "read" scripts +* server.sh + +4. Run one of the "read*.sh" scripts to get data + +5. Note: the "error" thrown by the read*.sh is because a buffer array is only alloted a +certain size upon creation which then throws an overflow error (harmless)