Tweak documentation and add explicit attribution for bash syntax high…

…lighting

README.md

@@ -71,7 +71,8 @@ as specified within the YAML file.
 
 ## System requirements
 
-Due to the libraries for parsing the YAML schema, Python >=3.10 is required.
+Due to the libraries for parsing the YAML schema, a Python installation of
+version greater than 3.10 is required.
 
 Since this tool uses Slurm to dispatch, the system must have Slurm installed
 in order to use the `record` functionality to dispatch runs. However, it can

docs/gallery.md

@@ -10,61 +10,61 @@ This page shows a gallery of the capabilities of the HPC MultiBench tool.
 ## Viewing run configurations
 
 <figure markdown="span">
-  ![Viewing run configurations](./images/hpc-multibench-run-configurations.png){ loading=lazy }
+  ![Viewing run configurations](./assets/images/hpc-multibench-run-configurations.png){ loading=lazy }
   <figcaption>A screenshot of the TUI viewing a run configuration, including the instantiation of variables and the Slurm sbatch file to run.</figcaption>
 </figure>
 
 ## Viewing aggregated metrics
 
 <figure markdown="span">
-  ![Viewing aggregated metrics](./images/hpc-multibench-aggregated-metrics.png){ loading=lazy }
+  ![Viewing aggregated metrics](./assets/images/hpc-multibench-aggregated-metrics.png){ loading=lazy }
   <figcaption>A screenshot of the TUI viewing the metric results extracted from and aggregated across a set of runs defined in the YAML file.</figcaption>
 </figure>
 
 ## Dispatching runs
 
 <figure markdown="span">
-  ![Viewing aggregated metrics](./images/hpc-multibench-dispatch-runs.png){ loading=lazy }
+  ![Viewing aggregated metrics](./assets/images/hpc-multibench-dispatch-runs.png){ loading=lazy }
   <figcaption>A screenshot of the TUI showing a modal dialog as it spawns Slurm jobs after  the "Run Test Plan" button is pressed.</figcaption>
 </figure>
 
 ## Line plots
 
 <figure markdown="span">
-  ![Plotext line plots](./images/hpc-multibench-line-plotext.png){ loading=lazy }
+  ![Plotext line plots](./assets/images/hpc-multibench-line-plotext.png){ loading=lazy }
   <figcaption>A screenshot of a a line plot of the metrics rendered entirely in the terminal.</figcaption>
 </figure>
 
 <figure markdown="span">
-  ![Plotext line plots](./images/hpc-multibench-line-plotext-2.png){ loading=lazy }
+  ![Plotext line plots](./assets/images/hpc-multibench-line-plotext-2.png){ loading=lazy }
   <figcaption>A screenshot of a a line plot of the metrics rendered entirely in the terminal.</figcaption>
 </figure>
 
 <figure markdown="span">
-  ![Matplotlib line plots](./images/hpc-multibench-line-matplotlib.png){ loading=lazy }
+  ![Matplotlib line plots](./assets/images/hpc-multibench-line-matplotlib.png){ loading=lazy }
   <figcaption>A screenshot of a Matplotlib window spawned by the TUI displaying a line plot including error bars of the metrics.</figcaption>
 </figure>
 
 ## Bar plots
 
 <figure markdown="span">
-  ![Plotext bar plots](./images/hpc-multibench-bar-plotext.png){ loading=lazy }
+  ![Plotext bar plots](./assets/images/hpc-multibench-bar-plotext.png){ loading=lazy }
   <figcaption>A screenshot of a a bar plot of the metrics rendered entirely in the terminal.</figcaption>
 </figure>
 
 <figure markdown="span">
-  ![Matplotlib bar plots](./images/hpc-multibench-bar-matplotlib.png){ loading=lazy }
+  ![Matplotlib bar plots](./assets/images/hpc-multibench-bar-matplotlib.png){ loading=lazy }
   <figcaption>A screenshot of a Matplotlib window spawned by the TUI displaying a bar plot including error bars of the metrics.</figcaption>
 </figure>
 
 ## Roofline plots
 
 <figure markdown="span">
-  ![Plotext roofline plots](./images/hpc-multibench-roofline-plotext.png){ loading=lazy }
+  ![Plotext roofline plots](./assets/images/hpc-multibench-roofline-plotext.png){ loading=lazy }
   <figcaption>A screenshot of a a roofline plot of the metrics rendered entirely in the terminal.</figcaption>
 </figure>
 
 <figure markdown="span">
-  ![Matplotlib roofline plots](./images/hpc-multibench-roofline-matplotlib.png){ loading=lazy }
+  ![Matplotlib roofline plots](./assets/images/hpc-multibench-roofline-matplotlib.png){ loading=lazy }
   <figcaption>A screenshot of a Matplotlib window spawned by the TUI displaying a roofline plot including error bars of the metrics.</figcaption>
 </figure>

docs/index.md

@@ -22,7 +22,8 @@ HPC batch compute jobs via Slurm from a convenient YAML format.
 
 ## System requirements
 
-Due to the libraries for parsing the YAML schema, Python >=3.10 is required.
+Due to the libraries for parsing the YAML schema, a Python installation of
+version greater than 3.10 is required.
 
 Since this tool uses Slurm to dispatch, the system must have Slurm installed
 in order to use the `record` functionality to dispatch runs. However, it can

src/hpc_multibench/tui/bash_highlights.py

@@ -8,6 +8,11 @@
 
 Which is aligned with the approach taken for Textual builtin languages, for example:
 https://github.com/Textualize/textual/blob/main/src/textual/tree-sitter/highlights/python.scm
+
+The Nvim treesitter library from which this is derived is licensed under the
+Apache 2.0 license, which allows modification and distribution for both public
+and private use. The original version of the grammar used was written by
+TravonteD on GitHub.
 """
 
 BASH_HIGHLIGHTS = """