From 4602eb3dfb03574c05632d84db5e77780d7350ec Mon Sep 17 00:00:00 2001
From: Henrique Gemignani Passos Lima <henrique@gemignani.org>
Date: Sun, 22 Dec 2024 17:34:03 +0200
Subject: [PATCH] Basic documentation improvements for tests

---
 README.md | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3a8dcab..134314b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 # Mercury Engine Data Structures
 Construct type definitions for Mercury Engine
 
+## Format Support
+
 | Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose     |
 |-----------|----------------------|-----------------------|--------------|---------------|-------------|
 | BAPD      | Missing              | Missing               | &check;      | &check;       | Audio Preset (positional audio data) |
@@ -19,13 +21,13 @@ Construct type definitions for Mercury Engine
 | BFSTM     | Missing              | Missing               | &cross;      | &cross;       | Common Switch audio format |
 | BGSNDS    | Missing              | Missing               | &check;      | &check;       | BackGround Sounds (?) |
 | BLDEF     | Missing              | Missing               | &check;      | &check;       | Actor Lighting Definition |
-| BLSND     | &check;              | &check;               | &check;      | &check;       | Sounds (?) |	
+| BLSND     | &check;              | &check;               | &check;      | &check;       | Sounds (?) |
 | BLUT      | Missing              | Missing               | &check;      | &check;       | LookUp Table (used for ADAM animation) |
 | BMBLS     | Missing              | Missing               | &check;      | &check;       | Blend Space |
 | BMDEFS    | &check;              | &check;               | &check;      | &check;       | Music Track Definitions & Properties	|
 | BMMAP     | Missing              | Missing               | &check;      | &check;       | MiniMap |
 | BMMDEF    | Missing              | Missing               | &check;      | &check;       | MiniMap Definitions (?) |
-| BMSAD     | &check;              | &check;               | &check;      | &check;       | Actor Definitions	| 
+| BMSAD     | &check;              | &check;               | &check;      | &check;       | Actor Definitions	|
 | BMSAS     | Missing              | Missing               | &check;      | &check;       | Action Sets |
 | BMSAT     | &cross;              | &cross;               | &check;      | &check;       | Animation Tree |
 | BMSBK     | &check;              | &check;               | Missing      | Missing       | Blocks, per Scenario |
@@ -44,7 +46,7 @@ Construct type definitions for Mercury Engine
 | BMSNAV    | &check;              | &check;               | &check;      | &check;       | Navigation Meshes	|
 | BMSND     | &cross;              | &cross;               | Missing      | Missing       | Sound (?)   |
 | BMSSA     | &cross;              | &cross;               | Missing      | Missing       | SSA (?)			|
-| BMSSD     | &check;              | &check;               | &check;      | &check;       | Scene Data (scene blocks, objects, msr lighting) |	
+| BMSSD     | &check;              | &check;               | &check;      | &check;       | Scene Data (scene blocks, objects, msr lighting) |
 | BMSSH     | Missing              | Missing               | &check;      | &check;       | GUI Shape |
 | BMSSK     | Missing              | Missing               | &check;      | &check;       | GUI Skin |
 | BMSSS     | Missing              | Missing               | &check;      | &check;       | GUI SpriteSheet |
@@ -62,7 +64,7 @@ Construct type definitions for Mercury Engine
 | BRSA      | Missing              | Missing               | &check;      | &check;       | SubArea Setups |
 | BRSPD     | Missing              | Missing               | &check;      | &check;       | Shot Audio Presets |
 | BSHDAT    | &cross;              | &cross;               | &cross;      | &cross;       | Shader Data	|
-| BSMAT     | Missing              | Missing               | &check;      | &check;       | Mesh Material |	
+| BSMAT     | Missing              | Missing               | &check;      | &check;       | Mesh Material |
 | BTUNDA    | Missing              | Missing               | &check;      | &check;       | Tunable Data |
 | BUCT      | &check;              | &check;               | &check;      | &check;       | Font Glyph Data (?) |
 | INI       | Missing              | Missing               | &check;      | &check;       | Standard INI |
@@ -93,3 +95,23 @@ Metroid Dread uses the following annotations in text to change color:
 | {c5} | Blue        |              |
 | {c6} | UI Active   | (Light blue) |
 | {c7} | UI Inactive | (Dim blue)   |
+
+
+## Tests
+
+For running the full test suite, the following environment variables must be set.
+
+| Variable           | Purpose                                        |
+|--------------------|------------------------------------------------|
+| SAMUS_RETURNS_PATH | Path to a Samus Returns extracted RomFS        |
+| DREAD_1_0_0_PATH   | Path to a Metroid Dread v1.0.0 extracted RomFS |
+| DREAD_2_1_0_PATH   | Path to a Metroid Dread v2.1.0 extracted RomFS |
+
+If any of these variables are not set, the associated tests are skipped.
+
+### Running
+
+```bash
+export SAMUS_RETURNS_PATH=D:/RomFS/Samus Returns
+python -m pytest
+```