Updating interactive tutorial for better clarity and fixing typos

Author: Neko-Box-Coder

Examples/InteractiveTutorial.cpp

@@ -597,33 +597,7 @@ void CallHello();
         WriteFile("tutorial/Hello.hpp", fileContent);
     }
 
-    DELAYED_OUTPUT("Turns out I still need to edit tutorial/main.cpp to call the function.");
-    DELAYED_OUTPUT("Let me do that now.");
-    DELAYED_OUTPUT("Press enter to continue...");
-    GetInput(true);
-    
-    {
-        std::string fileContent = ReadFile("tutorial/main.cpp");
-        if(fileContent.empty())
-        {
-            ssLOG_ERROR("Failed to read tutorial/main.cpp");
-            return false;
-        }
-
-        size_t returnPos = fileContent.find("return 0;");
-        if(returnPos == std::string::npos)
-        {
-            ssLOG_ERROR("Failed to find return 0; in tutorial/main.cpp");
-            return false;
-        }
-        fileContent.replace(returnPos, 
-                            std::string("return 0;").size(),
-                            "CallHello();\n    return 0;");
-
-        WriteFile("tutorial/main.cpp", std::string("#include \"Hello.hpp\"\n") + fileContent);
-    }
-
-    DELAYED_OUTPUT("Now let me add the second C++ file to `OtherFilesToBeCompiled` in the YAML file.");
+    DELAYED_OUTPUT("Now let me add the second C++ file to `SourceFiles` in the tutorial/main.yaml file.");
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
@@ -632,15 +606,15 @@ void CallHello();
     DefaultPlatform:
         DefaultProfile: ["WORLD=42"]
 
-OtherFilesToBeCompiled:
+SourceFiles:
     DefaultPlatform:
         DefaultProfile: ["./Hello.cpp"]
 )";
 
         WriteFile("tutorial/main.yaml", yamlContent);
     }
 
-    DELAYED_OUTPUT("The path to the other file is always **relative to the script file**.");
+    DELAYED_OUTPUT("The paths to the files are always __relative to the script file__.");
     DELAYED_OUTPUT("You can also add include paths for the script to the `IncludePaths` field");
     DELAYED_OUTPUT("Although unnecessary in this case, let me add \"./\" to the include paths.");
     DELAYED_OUTPUT("Press enter to continue...");
@@ -651,7 +625,7 @@ void CallHello();
     DefaultPlatform:
         DefaultProfile: ["WORLD=42"]
 
-OtherFilesToBeCompiled:
+SourceFiles:
     DefaultPlatform:
         DefaultProfile: ["./Hello.cpp"]
 
@@ -663,17 +637,43 @@ void CallHello();
         WriteFile("tutorial/main.yaml", yamlContent);
     }
 
+    DELAYED_OUTPUT("Turns out, I still need to edit tutorial/main.cpp to call the function.");
+    DELAYED_OUTPUT("Let me do that now.");
+    DELAYED_OUTPUT("Press enter to continue...");
+    GetInput(true);
+    
+    {
+        std::string fileContent = ReadFile("tutorial/main.cpp");
+        if(fileContent.empty())
+        {
+            ssLOG_ERROR("Failed to read tutorial/main.cpp");
+            return false;
+        }
+
+        size_t returnPos = fileContent.find("return 0;");
+        if(returnPos == std::string::npos)
+        {
+            ssLOG_ERROR("Failed to find return 0; in tutorial/main.cpp");
+            return false;
+        }
+        fileContent.replace(returnPos, 
+                            std::string("return 0;").size(),
+                            "CallHello();\n    return 0;");
+
+        WriteFile("tutorial/main.cpp", std::string("#include \"Hello.hpp\"\n") + fileContent);
+    }
+
     DELAYED_OUTPUT("Let's run the script again.");
     if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " main.cpp"))
         return false;
 
     DELAYED_OUTPUT("You should see the output `Hello from another C++ file`.");
     DELAYED_OUTPUT("");
 
-    DELAYED_OUTPUT( "If you **only** have a setting that applies to all platforms and profiles like "
+    DELAYED_OUTPUT( "If you **ONLY** have a setting that applies to all platforms and profiles like "
                     "what we have,");
     DELAYED_OUTPUT("you can specify the settings directly.");
-    DELAYED_OUTPUT("Let me update the YAML file and show you what I mean.");
+    DELAYED_OUTPUT("Let me update the tutorial/main.yaml file and show you what I mean.");
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
@@ -799,7 +799,7 @@ bool Chapter3_ExternalDependencies()
     DELAYED_OUTPUT("Press enter to continue...");
     GetInput(true);
 
-    DELAYED_OUTPUT("A dependency must contain a \"Source\" to determine where it is.");
+    DELAYED_OUTPUT("A dependency must contain a \"Source\" to determine where it is from.");
     DELAYED_OUTPUT("In this case, it is coming from a \"Git\" repository.");
     DELAYED_OUTPUT( "If you have a git submodule, you can point it to a local directory with "
                     "\"Local\" instead of \"Git\"");
@@ -808,7 +808,7 @@ bool Chapter3_ExternalDependencies()
 
     DELAYED_OUTPUT( "Next, you have \"LibraryType\" which tells runcpp2 what type of dependency "
                     "this is. Other options include \"Static\", \"Object\" and \"Shared\"");
-    DELAYED_OUTPUT("That's pretty much it for a header only library. Let's run it shell we?");
+    DELAYED_OUTPUT("That's pretty much it for a header only library. Let's run it shall we?");
     if(!RunCommandWithPrompt("cd tutorial && " + runcpp2ExecutablePath + " Logging.cpp"))
         return false;
 
@@ -998,7 +998,7 @@ bool Chapter3_ExternalDependencies()
             return false;
         }
 
-        DELAYED_OUTPUT("I have extracted the SDL2 dependency block to a standalone YAML file.");
+        DELAYED_OUTPUT("I have extracted the SDL2 dependency block to tutorial/SDL2.yaml file.");
         DELAYED_OUTPUT("Press enter to continue...");
         GetInput(true);