From 6b1c50ad279f9c8674500dfe27bd77ab3c8d1147 Mon Sep 17 00:00:00 2001 From: project-repo Date: Tue, 26 Dec 2023 22:25:04 +0100 Subject: [PATCH] Add doc to screenshot script. --- example_scripts/screenshot_script | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/example_scripts/screenshot_script b/example_scripts/screenshot_script index 5a75f64..8e4deb5 100644 --- a/example_scripts/screenshot_script +++ b/example_scripts/screenshot_script @@ -1,6 +1,14 @@ #!/bin/bash # Copyright 2023, project-repo, sodface and the cagebreak contributors # SPDX-License-Identifier: MIT +# +# Execute this script if you want to take a screenshot. +# Please supply your chosen cropping/editing tool as a +# command-line argument. The filepath to the temporary +# file will be given as an argument to your command. +# +# Example: +# screenshot_script "gwenview" source "$(dirname "${BASH_SOURCE[0]}")/cb_script_header.sh"