docs(general): Building via command line page updates for more focus …

…on testing section
YoYoGames · Aug 23, 2024 · 9f0c3ef · 9f0c3ef
1 parent ce463ed
commit 9f0c3ef
Showing 1 changed file with 13 additions and 5 deletions.
diff --git a/Manual/contents/Settings/Building_via_Command_Line.htm b/Manual/contents/Settings/Building_via_Command_Line.htm
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>Building via Command Line</title>
+  <title>Building &amp; Testing via Command Line</title>
   <meta name="generator" content="Adobe RoboHelp 2022" />
   <link rel="stylesheet" href="../assets/css/default.css" type="text/css" />
   <script src="../assets/scripts/main_script.js" type="module"></script>
@@ -15,7 +15,7 @@
 </head>
 <body>
   <!--<div class="body-scroll" style="top: 150px;">-->
-  <h1 id="h"><span data-field="title" data-format="default">Building via Command Line</span></h1>
+  <h1 id="h"><span data-field="title" data-format="default">Building &amp; Testing via Command Line</span></h1>
   <p class="note"><span data-conref="../assets/snippets/Tag_note.hts"> </span> Building executables via command line requires you to have <a href="../Setting_Up_And_Version_Information/Licencing_Information.htm">logged in to the IDE</a>.</p>
   <p>In addition to building your project through the IDE, <span data-keyref="GameMaker Name">GameMaker</span> allows you to build your projects through a command-line interface using the many options and commands described below. You can use this to build your project, test it and deploy it to multiple platforms by running one batch file, and to set up continuous integration through an automation server such as <a href="https://www.jenkins.io/" title="Jenkins">Jenkins</a>.</p>
   <p>This is done by running the <span class="inline2">Igor.exe</span> executable present within your runtime folder and passing in the options and commands listed on this page.</p>
@@ -25,8 +25,15 @@ <h1 id="h"><span data-field="title" data-format="default">Building via Command L
     <li>macOS: <span class="inline2">/Users/Shared/<span data-keyref="GameMaker_Paths_Directory_Name">GameMakerStudio2</span>/Cache/runtimes/runtime-[version]/bin/igor/osx/&lt;architecture&gt;/</span></li>
   </ul>
   <p class="note"><span data-conref="../assets/snippets/Tag_note.hts"> </span> You must have logged into the IDE with your account at least once before attempting command line building.</p>
+  <h3>Index</h3>
+  <p>This page covers the following:</p>
+  <ul class="colour">
+    <li><a href="#s1">Igor CI Building</a></li>
+    <li><a href="#s2">Igor Runtime</a></li>
+    <li><a href="#s3">Igor Testing</a></li>
+  </ul>
   <p> </p>
-  <h1>Igor CI Building</h1>
+  <h1 id="s1">Igor CI Building</h1>
   <h2>Setting Up</h2>
   <p>To set up CI building on a machine, you will need to do the following:</p>
   <ul class="colour">
@@ -303,7 +310,7 @@ <h2>Platform Examples</h2>
     <p class="code">Igor.exe /uf=[user_folder] /rp=[runtime_path] /project=[project_YYP_file] /cache=[cache_dir_path] /temp=[temp_dir_path] /of=[output_filename] /tf=[target_file] /runtime=YYC /device=[device_IDE_Name] -- Switch Package</p>
   </div>
   <p> </p>
-  <h1>Igor Runtime</h1>
+  <h1 id="s2">Igor Runtime</h1>
   <p>Here are the options that can be used with the Igor runtime:</p>
   <table>
     <tbody>
@@ -384,7 +391,7 @@ <h4>Syntax:</h4>
     </tbody>
   </table>
   <p> </p>
-  <h1>Igor Testing</h1>
+  <h1 id="s3">Igor Testing</h1>
   <p>Here are the options that can be used for testing your builds with Igor:</p>
   <table>
     <tbody>
@@ -425,6 +432,7 @@ <h1>Igor Testing</h1>
       </tr>
     </tbody>
   </table>
+  <p class="note"><span data-conref="../assets/snippets/Tag_important.hts"> </span> If you are facing bugs in your test set-up, please <a href="../Setting_Up_And_Version_Information/Error_Reporting.htm">submit a bug report</a> and attach your test files which we can review and test on our end.</p>
   <p>There is one command that you can use to run tests with Igor:</p>
   <p class="code">Igor.exe Tests RunTests [test_directory/test_filename]</p>
   <p>You must specify either a test directory or a test file name.</p>