From 8d70d75a288ac74e644ad57ea946327fd6dfdab6 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Tue, 12 Jul 2022 01:58:58 -0400 Subject: [PATCH] documentation --- README.md | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4ca1a99..5269005 100644 --- a/README.md +++ b/README.md @@ -35,26 +35,15 @@ Program options You can supply arguments to change the recorded packet capture animation: -``` -cargo run -- --file name_of_animation.pcap -``` - -Or, if compiled as a release binary, - -``` -xsens-packet-send.exe --file name_of_animation.pcap -``` +* Debug: `cargo run -- --file name_of_animation.pcap` +* Release build: `xsens-packet-send.exe --file name_of_animation.pcap` You can also change the computer you target: -``` -cargo run -- --host 192.168.2.100:8000 -``` +* Debug: `cargo run -- --host 192.168.2.100:8000` +* Release build: `xsens-packet-send.exe --host 192.168.2.100:8000` -Or, if compiled as a release binary, +You can combine both arguments together: -``` -xsens-packet-send.exe --host 192.168.2.100:8000 -``` - -You can combine both arguments together. +* Debug: `cargo run -- --file animation.pcap --host 192.168.2.100:8000` +* Release build: `xsens-packet-send.exe --file animation.pcap --host 192.168.2.100:8000`