From deb574cc5f54a87bb5a2dd67b82937d76e2e1b32 Mon Sep 17 00:00:00 2001
From: Roman Telezhynskyi <kroluku@gmail.com>
Date: Fri, 22 Jan 2016 17:01:20 +0200
Subject: [PATCH] Better documentation for script 'generate_tool_cursor.sh'.

--HG--
branch : develop
---
 scripts/generate_tool_cursor.sh               | 19 +++++++++++++++----
 .../share/resources/cursor/svg/README.txt     |  1 +
 2 files changed, 16 insertions(+), 4 deletions(-)
 create mode 100644 src/app/valentina/share/resources/cursor/svg/README.txt

diff --git a/scripts/generate_tool_cursor.sh b/scripts/generate_tool_cursor.sh
index da7e142ba..978b1f539 100755
--- a/scripts/generate_tool_cursor.sh
+++ b/scripts/generate_tool_cursor.sh
@@ -1,18 +1,29 @@
 #!/bin/bash
 
+# The script creates SVG templates for all cursors.
+# Before run create PNG icon of tool!
+# Use SVG templates for creating PNG cursors.
+
+# IMPORTANT!!! Run script inside 'scripts' directory.
+
 # usage:
 # $ ./generate_tool_cursor.sh
 
+# Notes.
+# No, template_cursor.svg is not broken! It is just template, no point open it.
+# After creating SVG templates open them by Inkscape, previewer doesn't show pictures inside svg file linked by url.
+# I have spent hour before understand why i don't see PNG inside SVG in Nautilus.
+
 PATTERN=*@2x.png
-TOOLICONPATH=../src/app/valentina/share/resources/toolicon/32x32/
+TOOLICONPATH=../src/app/valentina/share/resources/toolicon/32x32/ # PNG tool icon should be here
 TOOLICONS=`ls $TOOLICONPATH$PATTERN`
-OUTPATH=../src/app/valentina/share/resources/cursor/svg
+OUTPATH=../src/app/valentina/share/resources/cursor/svg # Seek SVG templates here
 
 
 for var in $TOOLICONS
 do
-	basename=${var##*/}
-	basename=${basename%.png}
+	basename=${var##*/} # remove the path from a path-string
+	basename=${basename%.png} # remove the extension from a path-string
 	basename=${basename%@2x} # remove optional @2x suffix
 	if [ ! -f $basename@2x.png ]; then # always prefere hidpi version
 		sed "s/<<basename>>/$basename@2x/" $OUTPATH/template_cursor.svg > $OUTPATH/${basename}_cursor.svg
diff --git a/src/app/valentina/share/resources/cursor/svg/README.txt b/src/app/valentina/share/resources/cursor/svg/README.txt
new file mode 100644
index 000000000..890bf785a
--- /dev/null
+++ b/src/app/valentina/share/resources/cursor/svg/README.txt
@@ -0,0 +1 @@
+Use script 'generate_tool_cursor.sh' in directory 'scripts' to generate all svg templates for cursors.