From 1822c981da238e9629157fb0548a96de84f6ac36 Mon Sep 17 00:00:00 2001
From: David Peter <mail@david-peter.de>
Date: Mon, 22 Nov 2021 20:45:39 +0100
Subject: [PATCH] Move comparison.sh benchmark script to documentation

---
 doc/alternatives.md            | 39 ++++++++++++++++++++++++++++++++++
 tests/benchmarks/comparison.sh | 33 ----------------------------
 2 files changed, 39 insertions(+), 33 deletions(-)
 delete mode 100755 tests/benchmarks/comparison.sh

diff --git a/doc/alternatives.md b/doc/alternatives.md
index 91540da3..665398fe 100644
--- a/doc/alternatives.md
+++ b/doc/alternatives.md
@@ -22,3 +22,42 @@ request.
 Some other alternatives that are also related, but not yet included in the table:
 - [lesspipe](https://github.com/wofr06/lesspipe)
 - [vimpager](https://github.com/rkitover/vimpager)
+
+## Benchmarks
+
+The benchmarks above have been created with this script:
+```bash
+#!/usr/bin/env bash
+
+cd "$(dirname "${BASH_SOURCE[0]}")" || exit
+
+if ! command -v hyperfine > /dev/null 2>&1; then
+    echo "'hyperfine' does not seem to be installed."
+    echo "You can get it here: https://github.com/sharkdp/hyperfine"
+    exit 1
+fi
+
+SRC="test-src/jquery-3.3.1.js"
+
+
+cmd_bat="bat --style=full --color=always --paging=never '$SRC'"
+cmd_bat_simple="bat --plain --wrap=never --tabs=0 --color=always --paging=never '$SRC'"
+cmd_pygmentize="pygmentize -g '$SRC'"
+cmd_highlight="highlight -O truecolor '$SRC'"
+cmd_ccat="ccat --color=always '$SRC'"
+cmd_source_highlight="source-highlight --failsafe --infer-lang -f esc -i '$SRC'"
+cmd_hicat="hicat '$SRC'"
+cmd_coderay="coderay '$SRC'"
+cmd_rouge="rougify '$SRC'"
+
+hyperfine --warmup 3 \
+    "$cmd_bat" \
+    "$cmd_bat_simple" \
+    "$cmd_pygmentize" \
+    "$cmd_highlight" \
+    "$cmd_ccat" \
+    "$cmd_source_highlight" \
+    "$cmd_hicat" \
+    "$cmd_coderay" \
+    "$cmd_rouge" \
+```
diff --git a/tests/benchmarks/comparison.sh b/tests/benchmarks/comparison.sh
deleted file mode 100755
index be1479e6..00000000
--- a/tests/benchmarks/comparison.sh
+++ /dev/null
@@ -1,33 +0,0 @@
-#!/usr/bin/env bash
-
-cd "$(dirname "${BASH_SOURCE[0]}")" || exit
-
-if ! command -v hyperfine > /dev/null 2>&1; then
-    echo "'hyperfine' does not seem to be installed."
-    echo "You can get it here: https://github.com/sharkdp/hyperfine"
-    exit 1
-fi
-
-SRC="test-src/jquery-3.3.1.js"
-
-
-cmd_bat="bat --style=full --color=always --paging=never '$SRC'"
-cmd_bat_simple="bat --plain --wrap=never --tabs=0 --color=always --paging=never '$SRC'"
-cmd_pygmentize="pygmentize -g '$SRC'"
-cmd_highlight="highlight -O truecolor '$SRC'"
-cmd_ccat="ccat --color=always '$SRC'"
-cmd_source_highlight="source-highlight --failsafe --infer-lang -f esc -i '$SRC'"
-cmd_hicat="hicat '$SRC'"
-cmd_coderay="coderay '$SRC'"
-cmd_rouge="rougify '$SRC'"
-
-hyperfine --warmup 3 \
-    "$cmd_bat" \
-    "$cmd_bat_simple" \
-    "$cmd_pygmentize" \
-    "$cmd_highlight" \
-    "$cmd_ccat" \
-    "$cmd_source_highlight" \
-    "$cmd_hicat" \
-    "$cmd_coderay" \
-    "$cmd_rouge" \