Add Testing section to the README

This section is intended to help others contribute to the project.
robballou · Oct 12, 2023 · 6a58558 · 6a58558
1 parent 1b7ab0e
commit 6a58558
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,16 @@ If these commands open the wrong file for you, open the Command Palette
     + Encryption ciphers
     + MACs
 
+## Testing
+
+- Install this repository under Sublime Text `Packages` and name it `SSH Config`
+    + by cloning the repo or moving it or symlinking it
+- Open the project from under `Packages/SSH Config`
+- Open a syntax test file located in the Tests directory
+- Run `Build With: Syntax Tests` command
+    + supplied by the `PackageDev` Sublime Package
+    + available on the command palette when a test file is open
+
 ## To-Do
 
 - Better highlighting for paths