IntelliJ launcher script description.

[meviz.git] / tools / open with IntelliJ IDEA

diff --git a/tools/open with IntelliJ IDEA b/tools/open with IntelliJ IDEA
index b8baee2..3d2d379 100755 (executable)
--- a/tools/open with IntelliJ IDEA
+++ b/tools/open with IntelliJ IDEA
@@ -1,5 +1,18 @@
 #!/bin/bash
 
+#
+# This is a helper bash script that starts IntelliJ with the current project.
+# Script is written is such a way that you can simply click on it in file
+# navigator to run it.
+#
+#
+# Script assumes:
+#
+#    + GNU operating system 
+#    + GNOME desktop environment 
+#    + IntelliJ is installed and commandline launcher "idea" is enabled.
+#
+
 cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi;
 
 cd ..