From 43fc33627915de7901060db1fbec89a44c52bc79 Mon Sep 17 00:00:00 2001
From: Peter Thedens <pthedens@iastate.edu>
Date: Mon, 13 Nov 2017 20:05:25 -0600
Subject: [PATCH] add more notes

---
 quad/doc/Unity_notes.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 quad/doc/Unity_notes.md

diff --git a/quad/doc/Unity_notes.md b/quad/doc/Unity_notes.md
new file mode 100644
index 000000000..9e08591c7
--- /dev/null
+++ b/quad/doc/Unity_notes.md
@@ -0,0 +1,10 @@
+# Unity Notes
+
+* When using Unity, be sure to define `UNITY_INCLUDE_CONFIG_H`
+to use the [`unity_config.h`](/Unity/src/unity_config.h).
+	* For the quad directory, this is done at compile-time of the Unity library [here](/Unity/src/Makefile)
+	and at compile-time of the test runner [here](/quad/library.mk).
+* Follow the examples in the [`Unity/examples`](/Unity/examples) for a guide as well
+as the documentation in [`Unity/docs`](/Unity/docs)
+	* Generally, the format is to start `main()` with `UNITY_BEGIN()`, followed by calls to `RUN_TEST(test_function)` where `test_function` is a test to run, ended with
+	`return UNITY_END()`
-- 
GitLab