enabled branding of the testkit docs
[feisty_meow.git] / testkit / doc / testkit_reference.html
index d6fbbd104e7fd87cc733ae0bf360232300807f7c..3fedb72388646abad0366056bce62a538c09f955 100644 (file)
@@ -5,7 +5,7 @@
   </head>
   <body vlink="purple" link="blue" lang="EN-US">
     <h1 style=" text-align:center">Feisty Meow® TestKit Reference Manual</h1>
-    <address style=" text-align:center">Version 1.0 ― Updated August 12 2020</address>
+    <address style=" text-align:center">Version 1.0 ― Updated August 14 2020</address>
     <h1>The Feisty Meow® TestKit</h1>
     <p>The TestKit is a collection of scripts that leverages the ShUnit unit
       testing environment.&nbsp; TestKit provides a pattern for creating test
@@ -20,7 +20,8 @@
       standard POSIX interfaces.<br>
     </p>
     <h2> Getting the TestKit</h2>
-    <p>Follow these steps to download and install the Feisty Meow TestKit:<br>
+    <p>Follow these steps to download and install a new "vanilla" version of the
+      TestKit:<br>
     </p>
     <div style="border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
 background:#DDD9C3;margin-left:.1in;margin-right:.1in">
@@ -31,6 +32,12 @@ margin-left:0in;background:#DDD9C3"><span style="font-family: monospace;">sudo
           cd /opt/feistymeow.org<br>
           git clone git://feistymeow.org/feisty_meow</span></p>
     </div>
+    <p>This is the code used to create the Feisty Meow® version of the TestKit.</p>
+    <p>It is possible to check out the TestKit within one's own code base, and
+      then it is possible to retrieve an updated Feisty Meow® TestKit by running
+      "git pull" on the "testkit" folder.&nbsp; This will get the latest version
+      from the Feisty Meow® Codebase without disturbing whatever project's
+      revision control repository contains the TestKit for testing.</p>
     <h3>Preparing the TestKit on Linux</h3>
     <p>Linux is the easiest environment for running the TestKit, given that the
       tests were built using the bash shell within a Linux environment.&nbsp; If
@@ -220,9 +227,9 @@ background:#DDD9C3;margin-left:.1in;margin-right:.1in">$ cd
     <div style="border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
 background:#DDD9C3;margin-left:.1in;margin-right:.1in">
       <p class="Code-Box" style="margin-top:6.0pt;margin-right:0in;margin-bottom:6.0pt;
-margin-left:0in;background:#DDD9C3">01: FAIL –
+margin-left:0in;background:#DDD9C3">01: OKAY –
         AckPfft_Tests/Gorp_Tests/deslagToaster.sh<br>
-        02: OKAY – AckPfft_Tests/Gorp_Tests/spumeMerchantry.sh<br>
+        02: FAIL – AckPfft_Tests/Gorp_Tests/spumeMerchantry.sh<br>
         03: OKAY – AckPfft_Tests/Gorp_Tests/octopusLauncher.sh<br>
         …<br>
         22: OKAY -- Snargle_Tests/scramTests/scramForPetunias.sh</p>