started work on documenting test cases

Author: Jason Kerney

.ionide/symbolCache.db

@@ -37,6 +37,8 @@ Instead the goal is to use the best aspects of your language to recreate the des
 
 Since the goal is expected behavior then I ask people to start by focusing on the tests. If you use the tests as a guide instead of the target code, you are in a better position for building a language native solution. This solution should be well designed.
 
+You can always refer to this [guide](.\test_cases.md) on the test cases to help you along. (NOTE: This guide is just being developed and may not be complete.)
+
 ### A Difference of Paradigm
 
 The initial solutions were done in an Object Oriented paradigm. If your language uses a different paradigm or even supports a different paradigm it is desirable that the refactoring not be held to being Object Oriented. In that case, I expect the tests to be very different.

contributing.md

@@ -13,6 +13,8 @@ Instead the goal is to use the best aspects of your language to recreate the des
 
 Since the goal is expected behavior then I ask people to start by focusing on the tests. If you use the tests as a guide instead of the target code, you are in a better position for building a language native solution. This solution should be well designed.
 
+You can always refer to this [guide](.\test_cases.md) on the test cases to help you along. (NOTE: This guide is just being developed and may not be complete.)
+
 ### A Difference of Paradigm
 
 The initial solutions were done in an Object Oriented paradigm. If your language uses a different paradigm or even supports a different paradigm it is desirable that the refactoring not be held to being Object Oriented. In that case, I expect the tests to be very different.

documentation/contrib/lang.md

@@ -0,0 +1,10 @@
+<!--bl
+(filemeta
+    (title "Introduction"))
+/bl-->
+
+This is to serve as documentation of the _minimum_ test cases you should have if creating a new language. It details the expected behavior of each shape.
+
+### A note on Paradigm
+
+The way these test cases is written may unintentionally favor an Object Oriented paradigm. If you find that to be true, please understand it is not the intent of this document. Please report it to me, or fix it and submit a pull request.

documentation/tests/intro.md

@@ -0,0 +1,9 @@
+<!--bl
+(filemeta
+    (title "Shape Test Cases")
+    (subtitle "A Guide to Making the Shape Classifier"))
+
+(table-of-contents
+    (section-main "./intro.md")
+)
+/bl-->

documentation/tests/main.md

@@ -26,9 +26,14 @@
             "command": "booklisp ./Languages/CSharp/documentation/main.md ./Languages/CSharp/readme.md",
             "description": "generates the documentation for the C# exercise"
         },
+        {
+            "name": "docsTests",
+            "command": "booklisp ./documentation/tests/main.md ./test_cases.md",
+            "description": "generates the documentation for the C# exercise"
+        },
         {
             "name": "docs",
-            "command": "cls; gittey docsMain; gittey docsJSOO; gittey docsCS",
+            "command": "cls; gittey docsMain; gittey docsTests; gittey docsJSOO; gittey docsCS",
             "description": "generates all the documentations"
         },
         {

gittey-config.json

@@ -0,0 +1,20 @@
+
+<!-- GENERATED DOCUMENT! DO NOT EDIT! -->
+# Shape Test Cases #
+#### A Guide to Making the Shape Classifier ####
+
+## Table Of Contents ##
+
+- [Section 1: Introduction](#user-content-introduction)
+
+## Introduction ##
+
+This is to serve as documentation of the _minimum_ test cases you should have if creating a new language. It details the expected behavior of each shape.
+
+### A note on Paradigm
+
+The way these test cases is written may unintentionally favor an Object Oriented paradigm. If you find that to be true, please understand it is not the intent of this document. Please report it to me, or fix it and submit a pull request.
+    
+
+<!-- GENERATED DOCUMENT! DO NOT EDIT! -->
+