From d79dddf72a2958395354c0dca100e17dd5bd72f9 Mon Sep 17 00:00:00 2001 From: noah Date: Mon, 2 Nov 2020 09:55:26 -0600 Subject: [PATCH] Prepped documentation for 0.1.0 release. --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f9849c0..b0d97fc 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -# Hyperspectral -TODO overview +# Hyperspectra + +`hyperspectra` is a cli tool for manipulating ENVI BIP, BIL, and BSQ files for processing +hyperspectral image data. ## Installation @@ -119,4 +121,8 @@ in the cache when the run began. | bsq | grey | 32.010 ± 0.323 | 31.743 | 32.497 | ## Testing -TODO \ No newline at end of file +Tests can be run by invoking `cargo test` on the command line. + +Benchmarks currently look for files in `./bench-data/` named `small.bil`, `small.bip`, `small.bsq`, +`small.bil.hdr`, `small.bip.hdr`, `small.bsq.hdr` and will delete any png, bip, bil, or bsq files +in the directory in which the benchmarks are run. Benchmarks use the `hyperfine` tool. \ No newline at end of file