From 3af88520dda4dfb241f39a48c9c46897905e281d Mon Sep 17 00:00:00 2001 From: Leonard Jonathan Oh Date: Thu, 15 Apr 2021 03:24:11 +0000 Subject: [PATCH 1/2] Docs: Update readme title and add badges --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8aad8c2..48f0ca9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# `benchie` +# benchie + +[![github-actions](https://github.com/theohbrothers/benchie/workflows/ci-master-pr/badge.svg)](https://github.com/theohbrothers/benchie/actions) +[![github-tag](https://img.shields.io/github/tag/theohbrothers/benchie)](https://github.com/theohbrothers/benchie/releases/) + A simple benchmarking tool. From f8215742c4b7c10bc6d3a372b83c3994ee9beed3 Mon Sep 17 00:00:00 2001 From: Leonard Jonathan Oh Date: Thu, 15 Apr 2021 03:34:37 +0000 Subject: [PATCH 2/2] Docs: Update usage output --- benchie.sh | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/benchie.sh b/benchie.sh index 02f8bc8..aeca60c 100755 --- a/benchie.sh +++ b/benchie.sh @@ -9,22 +9,21 @@ if [ "$1" = '--help' ] || [ "$1" = '-h' ] || [ "$1" = 'help' ]; then echo '' echo './benchie.sh start [benchmark] [[label]]' echo '# Starts the path/to/benchmark benchmark. Benchmark data created in path/to/benchmark/data' - echo './benchie.sh start client-network-latency' - echo './benchie.sh start client-network-latency homewifi' - echo './benchie.sh start client-network-latency hotspot' - echo './benchie.sh start client-network-latency wsgx' + echo './benchie.sh start path/to/benchmark' + echo './benchie.sh start path/to/benchmark home' + echo './benchie.sh start path/to/benchmark work' echo '' echo './benchie.sh status [benchmark]' - echo '# Gets all the benchmark PIDs of client-network-latency benchmark' - echo './benchie.sh status client-network-latency' + echo '# Gets all the benchmark PIDs of path/to/benchmark benchmark' + echo './benchie.sh status path/to/benchmark' echo '' echo './benchie.sh stop [benchmark]' - echo '# Kills all the benchmark PIDs of client-network-latency benchmark' - echo './benchie.sh stop client-network-latency' + echo '# Kills all the benchmark PIDs of path/to/benchmark benchmark' + echo './benchie.sh stop path/to/benchmark' echo '' echo './benchie.sh clean [benchmark]' - echo '# Cleans all the benchmark data folder client-network-latency/data' - echo './benchie.sh clean client-network-latency' + echo '# Cleans all the benchmark data folder path/to/benchmark/data' + echo './benchie.sh clean path/to/benchmark' exit 0 fi