From 770589d6661b0524f72bdc27193000e2c2b70269 Mon Sep 17 00:00:00 2001
From: askiiart <dev@askiiart.net>
Date: Tue, 12 Nov 2024 11:46:12 -0600
Subject: [PATCH] add readme details and update

---
 Cargo.lock | 24 ++++++++++++------------
 README.md  | 19 +++++++++++++++++++
 src/cli.rs |  3 +--
 3 files changed, 32 insertions(+), 14 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 8e3b37c..2c6c169 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -59,9 +59,9 @@ checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
 
 [[package]]
 name = "cc"
-version = "1.1.35"
+version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0f57c4b4da2a9d619dd035f27316d7a426305b75be93d09e92f2b9229c34feaf"
+checksum = "1aeb932158bd710538c73702db6945cb68a8fb08c519e6e12706b94263b36db8"
 dependencies = [
  "shlex",
 ]
@@ -129,9 +129,9 @@ checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
 
 [[package]]
 name = "csv"
-version = "1.3.0"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ac574ff4d437a7b5ad237ef331c17ccca63c46479e5b5453eb8e10bb99a759fe"
+checksum = "acdc4883a9c96732e4733212c01447ebd805833b7275a73ca3ee080fd77afdaf"
 dependencies = [
  "csv-core",
  "itoa",
@@ -165,9 +165,9 @@ dependencies = [
 
 [[package]]
 name = "curl-sys"
-version = "0.4.77+curl-8.10.1"
+version = "0.4.78+curl-8.11.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f469e8a5991f277a208224f6c7ad72ecb5f986e36d09ae1f2c1bb9259478a480"
+checksum = "8eec768341c5c7789611ae51cf6c459099f22e64a5d5d0ce4892434e33821eaf"
 dependencies = [
  "cc",
  "libc",
@@ -221,9 +221,9 @@ checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
 
 [[package]]
 name = "libc"
-version = "0.2.161"
+version = "0.2.162"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e9489c2807c139ffd9c1794f4af0ebe86a828db53ecdc7fea2111d0fed085d1"
+checksum = "18d287de67fe55fd7e1581fe933d965a5a9477b38e949cfa9f8574ef01506398"
 
 [[package]]
 name = "libz-sys"
@@ -350,18 +350,18 @@ dependencies = [
 
 [[package]]
 name = "serde"
-version = "1.0.214"
+version = "1.0.215"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f55c3193aca71c12ad7890f1785d2b73e1b9f63a0bbc353c08ef26fe03fc56b5"
+checksum = "6513c1ad0b11a9376da888e3e0baa0077f1aed55c17f50e7b2397136129fb88f"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.214"
+version = "1.0.215"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "de523f781f095e28fa605cdce0f8307e451cc0fd14e2eb4cd2e98a355b147766"
+checksum = "ad1e866f866923f252f05c889987993144fb74e722403468a4ebd70c3cd756c0"
 dependencies = [
  "proc-macro2",
  "quote",
diff --git a/README.md b/README.md
index c980818..a832df7 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,25 @@
 
 This tests the latency, sequential read, and random read speeds of a variety of data.
 
+## Installation
+
+To install this, run the following:
+
+```sh
+git clone https://git.askiiart.net/askiiart/disk-read-benchmark
+cd ./disk-read-benchmark/
+cargo update
+cargo install --path .
+```
+
+Make sure to generate and add the completions for your shell:
+
+- bash: `disk-read-benchmark generate-bash-completions | source`
+- zsh: `disk-read-benchmark generate-zsh-completions | source`
+- fish: `disk-read-benchmark generate-fish-completions | source`
+
+(note that this only lasts until the shell is closed)
+
 ## Running
 
 The program will automatically generate all data used, except for the regular polygon data. Once the data is generated, stop the program with Ctrl+C, then run `prepare.sh` to archive and mount the data using [DwarFS](https://github.com/mhx/dwarfs), `tar`, and [`fuse-archive`](https://github.com/google/fuse-archive).
diff --git a/src/cli.rs b/src/cli.rs
index 0ffe512..99dc6f7 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -7,8 +7,7 @@ pub struct Cli {
     pub command: Commands,
 }
 
-#[derive(Subcommand)]
-#[derive(Debug)]
+#[derive(Subcommand, Debug)]
 pub enum Commands {
     ///Generate bash completions
     GenerateBashCompletions,