From: Jacob Lifshay <programmerjake@gmail.com>
Date: Mon, 28 Aug 2017 12:22:05 +0000 (-0700)
Subject: added demo.md
X-Git-Tag: gsoc-2017~8
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=ad705558e225fb36d038f47b37ecee19bd44c186;p=kazan.git

added demo.md
---

diff --git a/docs/demo.md b/docs/demo.md
new file mode 100644
index 0000000..f0c2719
--- /dev/null
+++ b/docs/demo.md
@@ -0,0 +1,21 @@
+# demo executable
+
+## `demo/demo.cpp`
+
+### `test::load_file`
+loads a SPIR-V shader into memory, swapping the endian if needed.
+
+### `test::dump_words`
+dumps a SPIR-V shader's binary form to `stderr`. Displays the individual bytes in little-endian format to promote readability of SPIR-V strings.
+
+### `test::load_shader`
+loads a SPIR-V shader, creating a `pipeline::Shader_module`.
+
+### `test::make_pipeline_layout`
+creates the `pipeline::Pipeline_layout` object.
+
+### `test::parse_unsigned_integer`
+utility function to parse an unsigned integer.
+
+### `test::test_main`
+the main function. Builds a `pipeline::Graphics_pipeline`, draws to an image, then saves the image to `output.bmp`