Release v1.0.0

Cargo.toml

@@ -1,17 +1,21 @@
 [package]
 name = "core-to-core-latency"
-version = "0.1.0"
+description = "Measures CPU core-to-core latency"
+authors = ["Nicolas Viennot <nicolas@viennot.com>"]
+repository = "https://github.com/nviennot/core-to-core-latency"
+license = "MIT"
+readme = "README.md"
+version = "1.0.0"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+exclude = ["/results"]
 
 [dependencies]
-core_affinity = "*"
-minstant = { version = "*", optional = true }
+core_affinity = "0.5"
+minstant = { version = "0.1", optional = true }
 clap = { version = "3", features = ["derive"] }
-ndarray = "*"
-ansi_term = "*"
-ordered-float = "*"
+ndarray = "0.15"
+ansi_term = "0.12"
+ordered-float = "3"
 
 [features]
 default = ["rdtsc"]

README.md

@@ -1,6 +1,10 @@
 Measuring CPU core-to-core latency
 ==================================
 
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+[![Cargo](https://img.shields.io/crates/v/core-to-core-latency.svg)](https://crates.io/crates/core-to-core-latency)
+
+
 We measure the latency it takes for a CPU to send a message to another CPU via
 its cache coherence protocol.
 
@@ -88,12 +92,8 @@ How to use
 First [install Rust](https://www.rust-lang.org/tools/install) and `gcc` on linux, then:
 
 ```
-$ git clone https://github.com/nviennot/core-to-core-latency.git
-$ cd core-to-core-latency
-$ cargo run --release
-   Compiling core-to-core-latency v0.1.0 (/Users/pafy/core-to-core-latency)
-    Finished release [optimized] target(s) in 0.96s
-     Running `target/release/core-to-core-latency`
+$ cargo install core-to-core-latency
+$ core-to-core-latency
 Num cores: 10
 Using RDTSC to measure time: false
 Num round trips per samples: 1000
@@ -120,7 +120,7 @@ Mean latency: 38.4ns
 Contribute
 -----------
 
-Use `cargo run --release 5000 --csv > output.csv` to instruct the program to use
+Use `core-to-core-latency 5000 --csv > output.csv` to instruct the program to use
 5000 iterations per sample to reduce the noise, and save the results.
 
 It can be used in the jupter notebook [results/results.ipynb](results/results.ipynb) for rendering graphs.