From 44af9ff9b3fdb61cee74b786938cd69aad033824 Mon Sep 17 00:00:00 2001
From: Caleb Cornett <caleb.cornett@outlook.com>
Date: Wed, 9 Nov 2022 14:55:51 -0500
Subject: [PATCH] added a README

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9266c04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+Tests include:
+
+**ClearScreen**
+Clears the screen to CornflowerBlue. Mostly useful as a smoke test to make sure basic device init and render passes are working as intended.
+
+**ClearScreen_MultiWindow**
+Similar to above, but with two windows. Useful for testing window claim/unclaim logic and presenting to multiple swapchains.
+
+**BasicTriangle**
+Sets up a graphics pipeline and draws a triangle without vertex buffers. (The vertices are manually positioned in the vertex shader.) Also tests some basic rasterizer state with custom viewports, scissor rects, and fill/wireframe modes.
+
+**TriangleVertexBuffer**
+Similar to above, but using a MoonWorks vertex buffer and custom vertex structs.
+
+**TexturedQuad**
+Draws a textured quad to the screen. Tests texture binding, index buffers, and sampler states.
+
+**AnimatedTexturedQuad**
+Similar to above, but with rotating and color-blending animations. Tests vertex and fragment uniforms.
+
+**MSAA**
+Draws a basic triangle with varying MSAA sample counts.
+
+**CullMode**
+Draws several triangles with various culling modes and winding orders.