ADD leaderboard link and sample usage info

KCORES · Oct 7, 2024 · 98c217c · 98c217c
1 parent b5d99e6
commit 98c217c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,7 +5,7 @@ authors = ["Karminski <[email protected]>"]
 repository = "https://github.com/KCORES/core-to-core-latency-plus"
 license = "MIT"
 readme = "README-en-us.md"
-version = "0.1.16"
+version = "0.1.17"
 edition = "2021"
 exclude = ["/results"]
 

diff --git a/src/main.rs b/src/main.rs
@@ -3,18 +3,31 @@ mod utils;
 
 use bench::Count;
 use std::sync::Arc;
-use clap::Parser;
+use clap::{Parser};
 use quanta::Clock;
 use crate::bench::run_bench;
 use serde_json::json;
 use reqwest::blocking::Client;
 
-
 const DEFAULT_NUM_SAMPLES: Count = 300;
 const DEFAULT_NUM_ITERATIONS_PER_SAMPLE: Count = 1000;
 
-#[derive(Clone)]
-#[derive(clap::Parser)]
+#[derive(Clone, Parser)]
+#[clap(name = "core-to-core-latency-plus")]
+#[clap(version = env!("CARGO_PKG_VERSION"))]
+#[clap(about = " 
+ ██████╗ ██████╗ ██████╗ ███████╗
+██╔════╝██╔═══██╗██╔══██╗██╔════╝
+██║     ██║   ██║██████╔╝█████╗  
+██║     ██║   ██║██╔══██╗██╔══╝  
+╚██████╗╚██████╔╝██║  ██║███████╗
+ ╚═════╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝ to Core Latency + 
+                                                            
+For leaderboard, please visit: https://core-to-core-latency.kcores.com
+
+SAMPLE USAGE:
+    core-to-core-latency-plus 5000 300 -b 1 --upload
+                                                                       ")]
 pub struct CliArgs {
     /// The number of iterations per sample
     #[clap(default_value_t = DEFAULT_NUM_ITERATIONS_PER_SAMPLE, value_parser)]