diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-unit-testing-guide.mdx b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-testing-guide.mdx
similarity index 54%
rename from src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-unit-testing-guide.mdx
rename to src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-testing-guide.mdx
index d627659d..8959c930 100644
--- a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-unit-testing-guide.mdx
+++ b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/01-testing-guide.mdx
@@ -1,122 +1,79 @@
---
-title: Unit Testing Guide
+title: Testing Guide
---
-import { FileTree, Steps, Tabs, TabItem } from "@astrojs/starlight/components";
+import { Steps, Tabs, TabItem } from "@astrojs/starlight/components";
-## Introduction
+You cannot create new programs with splashkit-core as you do when using the traditional SplashKit
+library. Instead, two programs are generated which can be configured to test its functionality:
+`sktest` and `skunit_tests`. They are built with CMake using a preconfigured `CMakeLists.txt` file,
+which builds the SplashKit library and both test programs.
-SplashKit uses [Catch2 2.x](https://github.com/catchorg/Catch2/tree/v2.x) as a framework for unit
-tests.
+### Making Changes
-Tests are written in C++ with the aid of macros from Catch2. Test files are located at:
+`sktest` is built with the .cpp files from `splashkit-core/coresdk/src/test/`. To add your own
+tests, modify one or more of the files such as `test_animation.cpp`. Tests in `sktest` tend to focus
+on demonstrating the output of functions, and require a human to validate that output. They are
+written in standard C++ and can make use of SplashKit functions.
-
+`skunit_tests` is built with the .cpp files from `splashkit-core/coresdk/src/test/unit_tests/`.
+When it runs, all unit tests from all files in this folder are executed. Additional files can be
+added to this folder if necessary. If adding a new file, copy the structure from one of the existing
+unit test files. Unlike `sktest`, tests here need to be written as Catch2 test cases and
+`#include "catch.hpp"` must be present in a given file for it to be compiled into `skunit_tests`.
+These tests evaluate actual output against expected output and produce an error if a test fails. See
+the
+[unit testing guide](/products/splashkit/documentation/splashkit-expansion/02-unit-testing-guide)
+for a more in depth explanation of how unit tests are written.
-- coresdk
- - src
- - test
- - unit_test_main.cpp
- - `unit_test_.cpp`
+## Building the test project
-
+If a change is made to the code, the build process needs to be run. This applies whether changes
+were made to coresdk files (such as adding new functions to SplashKit or changing existing code) or
+new tests were added to sktest or skunit_tests.
-`unit_test_main.cpp` is the entry point for all unit tests. You do not need to modify this to write
-your own tests or update existing ones.
+### From the command line
-The `unit_test_.cpp` files contain tests for related parts of SplashKit. For example,
-`unit_test_utilities.cpp` has tests for SplashKit's utility functions. A test file must include the
-Catch2 header file along with any other includes required:
+
+
-```cpp
-#include "catch.hpp"
+```shell
+cd projects/cmake
+cmake --preset Linux
+cmake --build build/
```
-## Writing a Unit Test
-
-At a minimum, a unit test consists of a `TEST_CASE` and an assertion (usually `REQUIRE`):
+
+
-```cpp
-TEST_CASE("gets the number of milliseconds that have passed since the program was started", "[current_ticks]")
-{
- unsigned int result = current_ticks();
- REQUIRE(result >= 0);
-}
+```shell
+cd projects/cmake
+cmake --preset macOS
+cmake --build build/
```
-`TEST_CASE(name, [,tags])` defines a test case with the given name and, optionally, one or more
-tags.
-
-`REQUIRE` evaluates an expression and aborts the test as a failure if the result is false.
-`REQUIRE_FALSE` is similar but fails if the expression evaluates true. There are
-[other assertion macros](https://github.com/catchorg/Catch2/blob/v2.x/docs/assertions.md#top) but
-these are the most common.
-
-A test may contain multiple assertions:
-
-```cpp
-TEST_CASE("random number float between 0 and 1 is generated", "[rnd]")
-{
- float result = rnd();
- REQUIRE(result >= 0);
- REQUIRE(result <= 1);
-}
-```
+
+
-You may write tests that have some common steps, such as defining a variable. You can define one or
-more `SECTION(name)` inside a `TEST_CASE`. The `TEST_CASE` is run from the start for each `SECTION`.
-
-```cpp
-TEST_CASE("return a SplashKit resource of resource_kind with name filename as a string", "[file_as_string]")
-{
- const resource_kind RESOURCE = resource_kind::BUNDLE_RESOURCE;
- const string RESOURCE_PATH = "blah.txt";
-
- SECTION("filename is a valid file")
- {
- string result = file_as_string(RESOURCE_PATH, RESOURCE);
- string expected = "BITMAP,ufo,ufo.png\n";
- REQUIRE(result == expected);
- }
- SECTION("filename is an empty string")
- {
- string result = file_as_string("", RESOURCE);
- string expected = "";
- REQUIRE(result == expected);
- }
- SECTION("filename is an invalid file")
- {
- string result = file_as_string("invalid.txt", RESOURCE);
- string expected = "";
- REQUIRE(result == expected);
- }
-}
+```shell
+cd projects/cmake
+cmake --preset Windows
+cmake --build build/
```
-This test has three `SECTION`s, so the `TEST_CASE` will run three times. Each time, the `RESOURCE`
-and `RESOURCE_PATH` variables will be defined.
+
+
-## Building the test project
+### In VS Code
-1. Open a terminal and install prerequisites with these commands:
-
- ```shell
- sudo apt-get update
- sudo apt-get upgrade -y
- sudo apt-get install -y \
- git build-essential cmake g++ libpng-dev libcurl4-openssl-dev libsdl2-dev \
- libsdl2-mixer-dev libsdl2-gfx-dev libsdl2-image-dev libsdl2-net-dev libsdl2-ttf-dev \
- libmikmod-dev libbz2-dev libflac-dev libvorbis-dev libwebp-dev libfreetype6-dev
- ```
-
-2. Install the CMake Tools extension from the VS Code extension browser or
+1. Install the CMake Tools extension from the VS Code extension browser or
[here](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools).
-3. Configure the extension:
+2. Configure the extension:
Select `${workspaceFolder}/projects/cmake/CMakeLists.txt`
Select the Linux preset
@@ -124,23 +81,13 @@ and `RESOURCE_PATH` variables will be defined.
Select the Default configure preset
In the CMake Tools extension click the button
-  next to Build and select
- skunit_tests
- 
+  next to Build and select all
+ 
Click the button  next to
Debug and select skunit_tests
-4. Build test project:
- From the command line:
-
- ```shell
- cd projects/cmake
- cmake --preset Linux
- cmake --build build/
- ```
-
- Or in VS Code:
+3. Build test project:
In the CMake Tools extension, click the Build button. The test project will also be built when
you refresh tests on the Testing tab of VS Code.
@@ -161,43 +108,26 @@ and `RESOURCE_PATH` variables will be defined.
Select the Default configure preset
In the CMake Tools extension click the button
-  next to Build and select
- skunit_tests
- 
+  next to Build and select all
+ 
Click the button  next to
Debug and select skunit_tests
3. Build test project:
- From the command line:
-
- ```shell
- cd projects/cmake
- cmake --preset macOS
- cmake --build build/
- ```
-
- Or in VS Code:
In the CMake Tools extension, click Build. The test project will also be built when you refresh
tests on the Testing tab of VS Code.
-
+
-1. Open the MINGW64 terminal and install prerequisites with these commands:
-
- ```shell
- pacman -Syu
- pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-cmake mingw-w64-x86_64-make
- ```
-
-2. Install the CMake Tools extension from the VS Code extension browser or
+1. Install the CMake Tools extension from the VS Code extension browser or
[here](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools).
-3. Configure the extension:
+2. Configure the extension:
Select `${workspaceFolder}/projects/cmake/CMakeLists.txt`
Select the Windows preset
@@ -205,23 +135,13 @@ and `RESOURCE_PATH` variables will be defined.
Select the Default configure preset
In the CMake Tools extension click the button
-  next to Build and select
- skunit_tests
- 
+  next to Build and select all
+ 
Click the button  next to
Debug and select skunit_tests
-4. Build test project:
- From the command line:
-
- ```shell
- cd projects/cmake
- cmake --preset Windows
- cmake --build build/
- ```
-
- Or in VS Code:
+3. Build test project:
In the CMake Tools extension, click Build. The test project will also be built when you refresh
tests on the Testing tab of VS Code.
@@ -230,15 +150,99 @@ and `RESOURCE_PATH` variables will be defined.
-## Running unit tests
+## Running Tests
-### From the command line
+After building the test programs, the compiled executables wiil be found in the `splashkit-core/bin`
+directory. Running tests differs depending on if the tests are part of `sktest` or `skunit_tests`.
+
+### The sktest program
+
+
+
+
+To run `sktest`, open a terminal and enter:
+
+```shell
+cd splashkit-core/bin
+./sktest
+```
+
+
+
+
+To run `sktest`, open a terminal and enter:
+
+```shell
+cd splashkit-core/bin
+./sktest
+```
+
+
+
+
+To run `sktest`, open the MinGW terminal and enter:
+
+```shell
+cd splashkit-core/bin
+./sktest.exe
+```
+
+
+
+
+A menu will be presented, showing a list of all the tests that are part of sktest. Select a test to
+run by entering the corresponding number.
+
+```plaintext
+---------------------
+ SplashKit Dev Tests
+---------------------
+ -1: Quit
+ 0: Animations
+ 1: Audio
+ 2: Bundles
+ 3: Camera
+ 4: Geometry
+ 5: Graphics
+ 6: Input
+ 7: Logging
+ 8: Physics
+ 9: Resources
+ 10: Shape drawing
+ 11: Sprite tests
+ 12: Terminal
+ 13: Text
+ 14: Timers
+ 15: Windows
+ 16: Cave Escape
+ 17: Web Server
+ 18: RESTful Web Service
+ 19: Network conversions
+ 20: UDP Networking Test
+ 21: TCP Networking Test
+ 22: GPIO Tests
+ 23: ADC Tests
+ 24: Motor Driver Tests
+ 25: Servo Driver Tests
+ 26: Remote GPIO Tests
+ 27: GPIO Tests - SPI
+ 28: UI Tests
+---------------------
+ Select test to run:
+```
+
+### Unit tests
+
+Unit tests are built with the same process as `sktest`, but run with the `skunit_tests` program.
+
+#### From the command line
- It's a good idea to run the unit tests in a random order so that you can confirm that they run
- indepedently of one another:
+ indepedently of one another. If tests run in order, you may miss issues that occur when a test
+ runs without the tests before it passing.
```shell
cd ../../bin
@@ -262,7 +266,8 @@ and `RESOURCE_PATH` variables will be defined.
- It's a good idea to run the unit tests in a random order so that you can confirm that they run
- indepedently of one another:
+ indepedently of one another. If tests run in order, you may miss issues that occur when a test
+ runs without the tests before it passing.
```shell
cd ../../bin
@@ -283,10 +288,11 @@ and `RESOURCE_PATH` variables will be defined.
run all of the tests with "string" in the name.
-
+
- It's a good idea to run the unit tests in a random order so that you can confirm that they run
- indepedently of one another:
+ indepedently of one another. If tests run in order, you may miss issues that occur when a test
+ runs without the tests before it passing.
```shell
cd ../../bin
@@ -309,10 +315,10 @@ and `RESOURCE_PATH` variables will be defined.
-### In VS Code
+#### In VS Code
-You can run tests from the Testing tab in VS Code
-
+You can run tests from the Testing tab in VS Code if you've set up the CMake Tools extension as
+outlined above 
- Running all tests:
Click Run Tests. Each test will be run and the status of each can be seen in the test list after a
@@ -322,8 +328,3 @@ You can run tests from the Testing tab in VS Code
Click Run Test next to any test on the test list to run it
-
-## See Also
-
-- [Catch2 tutorial](https://github.com/catchorg/Catch2/blob/v2.x/docs/tutorial.md)
-- [Catch2 reference](https://github.com/catchorg/Catch2/blob/v2.x/docs/Readme.md)
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/02-unit-testing-guide.mdx b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/02-unit-testing-guide.mdx
new file mode 100644
index 00000000..3065840f
--- /dev/null
+++ b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/02-unit-testing-guide.mdx
@@ -0,0 +1,110 @@
+---
+title: Unit Testing Guide
+---
+
+import { FileTree, Steps, Tabs, TabItem } from "@astrojs/starlight/components";
+
+Unit tests are written in C++ with the aid of macros from
+[Catch2 2.x](https://github.com/catchorg/Catch2/tree/v2.x). These tests are suited for larger scale
+testing than `sktest`, as a large number of tests can be quickly run and the output easily checked.
+This makes them suited for automation, because any failing test will be flagged so that any issues
+can be resolved before merging the changes into the main repository of SplashKit.
+
+When writing unit tests, you should aim to test the expected behaviour of a specific function or
+procedure. In addition to positive test cases (where the function or procedure takes valid input and
+should produce the expected output), consider negative cases (cases where the function or procedure
+has invalid input), as well as edge cases.
+
+## File structure
+
+Test files are located at:
+
+
+
+- coresdk
+ - src
+ - test
+ - unit_test_main.cpp
+ - `unit_test_.cpp`
+
+
+
+`unit_test_main.cpp` is the entry point for all unit tests. You do not need to modify this to write
+your own tests or update existing ones.
+
+The `unit_test_.cpp` files contain tests for related parts of SplashKit. For example,
+`unit_test_utilities.cpp` has tests for SplashKit's utility functions. A test file must include the
+Catch2 header file along with any other includes required:
+
+```cpp
+#include "catch.hpp"
+```
+
+## Writing a Unit Test
+
+At a minimum, a unit test consists of a `TEST_CASE` and an assertion (usually `REQUIRE`):
+
+```cpp
+TEST_CASE("gets the number of milliseconds that have passed since the program was started", "[current_ticks]")
+{
+ unsigned int result = current_ticks();
+ REQUIRE(result >= 0);
+}
+```
+
+`TEST_CASE(name, [,tags])` defines a test case with the given name and, optionally, one or more
+tags.
+
+`REQUIRE` evaluates an expression and aborts the test as a failure if the result is false.
+`REQUIRE_FALSE` is similar but fails if the expression evaluates true. There are
+[other assertion macros](https://github.com/catchorg/Catch2/blob/v2.x/docs/assertions.md#top) but
+these are the most common.
+
+A test may contain multiple assertions:
+
+```cpp
+TEST_CASE("random number float between 0 and 1 is generated", "[rnd]")
+{
+ float result = rnd();
+ REQUIRE(result >= 0);
+ REQUIRE(result <= 1);
+}
+```
+
+You may write tests that have some common steps, such as defining a variable. You can define one or
+more `SECTION(name)` inside a `TEST_CASE`. The `TEST_CASE` is run from the start for each `SECTION`.
+
+```cpp
+TEST_CASE("return a SplashKit resource of resource_kind with name filename as a string", "[file_as_string]")
+{
+ const resource_kind RESOURCE = resource_kind::BUNDLE_RESOURCE;
+ const string RESOURCE_PATH = "blah.txt";
+
+ SECTION("filename is a valid file")
+ {
+ string result = file_as_string(RESOURCE_PATH, RESOURCE);
+ string expected = "BITMAP,ufo,ufo.png\n";
+ REQUIRE(result == expected);
+ }
+ SECTION("filename is an empty string")
+ {
+ string result = file_as_string("", RESOURCE);
+ string expected = "";
+ REQUIRE(result == expected);
+ }
+ SECTION("filename is an invalid file")
+ {
+ string result = file_as_string("invalid.txt", RESOURCE);
+ string expected = "";
+ REQUIRE(result == expected);
+ }
+}
+```
+
+This test has three `SECTION`s, so the `TEST_CASE` will run three times. Each time, the `RESOURCE`
+and `RESOURCE_PATH` variables will be defined.
+
+## See Also
+
+- [Catch2 tutorial](https://github.com/catchorg/Catch2/blob/v2.x/docs/tutorial.md)
+- [Catch2 reference](https://github.com/catchorg/Catch2/blob/v2.x/docs/Readme.md)
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/02-onboarding-guide.mdx b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/03-onboarding-guide.mdx
similarity index 100%
rename from src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/02-onboarding-guide.mdx
rename to src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/03-onboarding-guide.mdx
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/03-improvement-suggestion-add-oop-collision-resolution.mdx b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/04-improvement-suggestion-add-oop-collision-resolution.mdx
similarity index 100%
rename from src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/03-improvement-suggestion-add-oop-collision-resolution.mdx
rename to src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/04-improvement-suggestion-add-oop-collision-resolution.mdx
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target-unit-tests.png b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target-unit-tests.png
deleted file mode 100644
index 03d4ffdc..00000000
Binary files a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target-unit-tests.png and /dev/null differ
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target.png b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target.png
new file mode 100644
index 00000000..0796d655
Binary files /dev/null and b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/3-target.png differ
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/5-build.png b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/5-build.png
index 2cde00a3..4607cb07 100644
Binary files a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/5-build.png and b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/images/build-unit-tests/5-build.png differ
diff --git a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/index.mdx b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/index.mdx
index d7f935ff..6519fe58 100644
--- a/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/index.mdx
+++ b/src/content/docs/Products/SplashKit/Documentation/SplashKit Expansion/index.mdx
@@ -44,74 +44,13 @@ git checkout {new branch name}
Now that a new branch is created and active, development can begin.
-### Building the Test Programs
-
-You cannot create new programs with splashkit-core as you do when using the traditional SplashKit
-library. Instead, two programs are generated which can be configured to test its functionality:
-`sktest` and `skunit_tests`. They are built with CMake using a preconfigured `CMakeLists.txt` file.
-Open a WSL terminal and enter:
-
-```shell
-cd
-cd splashkit-core/projects/cmake
-cmake -G "Unix Makefiles" .
-make
-```
-
-The associated macOS and Linux commands can be found here:
-[CONTRIBUTING](https://github.com/thoth-tech/splashkit-core/blob/develop/CONTRIBUTING.md)
-
-### Running the Test Programs
-
-To run the test programs, open a WSL terminal and enter:
-
-```shell
-cd
-cd splashkit-core/bin
-```
-
-Then for sktest:
-
-```shell
-./sktest
-```
-
-Or for skunit_tests:
-
-```shell
-./skunit_tests
-```
-
-### Making Changes
-
-`sktest` is built with the .cpp files from `~/splashkit-core/coreskd/src/test/`. To add your own
-tests, modify one or more of the files such as `test_animation.cpp`.
-
-`skunit_tests` is built with the .cpp files from `~/splashkit-core/coreskd/src/test/unit_tests/`.
-When it runs, all unit tests from all files in this folder are executed. Additional files can be
-added to this folder if necessary. If adding a new file, copy the structure from one of the existing
-unit test files. Critically, `#include "catch.hpp"` must be present in the file for it to be
-compiled into `skunit_tests`. Beyond that, the hierarchy of, `TEST_CASE > SECTION > ASSERTION`
-should be followed to improve readability and tracing of errors.
-
### Testing Changes
-If a change is made to the code, the test programs need to be rebuilt. In a WSL terminal enter:
-
-```shell
-cd
-cd splashkit-core/projects/cmake
-make
-```
-
-If any files were created or deleted, the CMake files need to be regenerated. In that case use:
-
-```shell
-cd
-cd splashkit-core/projects/cmake
-cmake -G "Unix Makefiles" .
-make
-```
+It is critical that changes made to splashkit-core are thoroughly tested, so that issues can be
+found and resolved early. When making changes to code, whether adding new functions or altering
+existing functions, be sure to run the existing tests and think about adding new ones to test your
+changes. See [the testing guide](/products/splashkit/documentation/splashkit-expansion/01-testing-guide/) to get
+started with testing.
### Documenting Changes
@@ -155,3 +94,7 @@ following guide details the procedure and etiquette which is expected while usin
Solutions for common issues can be found below. Be sure to also check the following page for help
troubleshooting:
[Guide to resolving Common Issues](/products/splashkit/03-github-guide/#troubleshooting)
+
+### See Also
+
+[splashkit-core CONTRIBUTING.md](https://github.com/thoth-tech/splashkit-core/blob/develop/CONTRIBUTING.md)