Make voglgen accept specdir as option

[vogl] / qtcreator / qtcreator.md

diff --git a/qtcreator/qtcreator.md b/qtcreator/qtcreator.md
index 96b6f622e33181d0e44b69e00414b37e052aeaff..6f70acab8177efe053d08f1de0995a3447eeed2a 100644 (file)
--- a/qtcreator/qtcreator.md
+++ b/qtcreator/qtcreator.md
@@ -22,7 +22,7 @@ You should now be able to click in bottom left "Type to locate" control (or hit
  * Mouse over the "Make: make" step and click the 'x' to delete it.
  * Click <Add Build Step>, and select "Custom Process Step".
 
-    <b>Command:</b> /home/mikesart/dev/voglproj/vogl/bin/mkvogl.sh  
+    <b>Command:</b> %{buildDir}/../bin/mkvogl.sh  
     <b>Arguments:</b> --amd64 --debug 3>&1 1>&2 2>&3  
 
 * Now select "Choose Build / Build Project..." or (Ctrl+B)
@@ -34,7 +34,7 @@ You should now be able to click in bottom left "Type to locate" control (or hit
  * Mouse over the "Make: make clean" step and click the 'x' to delete it.
  * Click "Add Clean Step", select "Custom Process Step".
 
-    <b>Command:</b> /home/mikesart/dev/voglproj/vogl/bin/mkvogl.sh  
+    <b>Command:</b> %{buildDir}/../bin/mkvogl.sh  
     <b>Arguments:</b> --amd64 --debug --cleanonly  
 
 
@@ -45,9 +45,25 @@ You should now be able to click in bottom left "Type to locate" control (or hit
  * Click "Add"; select "Clone selected"; follow steps below
 
 * Repeat the steps above for the remaining build configurations:
- * <b>amd64_release":</b> Arguments: --amd64 --release --verbose 3>&1 1>&2 2>&3
- * <b>i386_debug:</b> Arguments: --i386 --debug --verbose 3>&1 1>&2 2>&3
- * <b>i386_release":</b> Arguments: --i386 --release --verbose 3>&1 1>&2 2>&3
+ * <b>"amd64_release":</b> Arguments: --amd64 --release --verbose 3>&1 1>&2 2>&3
+ * <b>"i386_debug":</b> Arguments: --i386 --debug --verbose 3>&1 1>&2 2>&3
+ * <b>"i386_release":</b> Arguments: --i386 --release --verbose 3>&1 1>&2 2>&3
 
 
-Not that you can use the "--usemake" flag with mkvolg.sh if you don't want to use Ninja. If you do this, remove the "3>&1 1>&2 2>&3" redirections also.
+Note that you can use the "--usemake" flag with mkvolg.sh if you don't want to use Ninja. If you do this, remove the "3>&1 1>&2 2>&3" redirections also.
+
+### Launching and Debugging projects ###
+
+The default 'Run configuration' called "VoglProj" that QtCreator adds will not be associated with any binary and therefore cannot be executed. The directions below show how to launch the 64-bit vogleditor.
+
+* Within the <Projects> tab, switch to the "Run" settings
+ * Under "Run", "Run configuration:" click "Add", select "Custom Executable"
+ * Click "Rename..." and customize this run configuration with an appropriate name (eg, "vogleditor64")
+ * For the <b>Executable:</b>, enter: %{buildDir}/../vogl_build/bin/vogleditor64
+ * For the <b>Arguments:</b>, you may optionally enter a path to a trace file
+ * <b>Run in terminal</b> does not need to be enabled for vogleditor, but is useful (required?) for other binaries
+
+* Hit [F5] to start debugging
+
+This approach allows you to configure mutliple run configurations that (for example) each launch the vogleditor64 with a different trace file as a parameter, or you can have another configuration that launches vogleditor32, or voglreplay64 with parameters to debug why a replay or trim is not working properly.
+