From 5b72abfc0d87e45acd8b4ddc970619b5e215c780 Mon Sep 17 00:00:00 2001
From: askiiart <dev@askiiart.net>
Date: Tue, 12 Nov 2024 19:37:35 -0600
Subject: [PATCH] add much more info

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index a832df7..66fa8e8 100644
--- a/README.md
+++ b/README.md
@@ -38,3 +38,36 @@ filesystem dir,file path,sequential read time,sequential read latency,random rea
 ```txt
 filesystem dir,folder path,test type,time1,time2,time3,[...]
 ```
+
+### Arguments
+
+```txt
+Usage: disk-read-benchmark <COMMAND>
+
+Commands:
+  generate-bash-completions  Generate bash completions
+  generate-zsh-completions   Generate zsh completions
+  generate-fish-completions  Generate fish completions
+  grab-data                  Grabs the datasets used for benchmarking
+  benchmark                  Runs the benchmark
+  prep-dirs                  Prepares the directories so other programs can prepare their datasets
+  run                        Runs it all
+  help                       Print this message or the help of the given subcommand(s)
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version
+```
+
+### Data used
+
+- 25 GiB random file
+- 25 GiB empty file
+- 1024 1 KiB random files
+- 1024 1 KiB empty files
+- Linux kernel source (compressed and non-compressed)
+- 100 million-sided regular polygon, generated by the `headless-deterministic` branch of [confused_ace_noises/maths-demos](https://git.askiiart.net/confused_ace_noises/maths-demos)
+
+## Usage
+
+You can put the data in folders in `./data/mountpoints/`, which can be on different filesystems (including stuff like [DwarFS](https://github.com/mhx/dwarfs) archives mounted with FUSE). Running `grab-data` and `prep-dirs` will create all the necessary files it can, at which point you just add the polygon data, put the stuff to be benchmarked in the `mountpoints` dir, then run it with the `benchmark` argument.