summaryrefslogtreecommitdiff
path: root/bench/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'bench/README.md')
-rw-r--r--bench/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/bench/README.md b/bench/README.md
new file mode 100644
index 0000000..4016024
--- /dev/null
+++ b/bench/README.md
@@ -0,0 +1,9 @@
+# tinyff benching util
+
+This folder contains benchmarks for every format. It also contains an API which is used to make custom benches.
+
+## Structure
+
+`format/`: Contains benchmark tests for formats
+`test/`: Contains tests for common formats. These are example programs.
+`bench.c & bench.h`: The API for the making the `format/` directory. \ No newline at end of file