aboutsummaryrefslogtreecommitdiff
path: root/optional/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'optional/README.md')
-rw-r--r--optional/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/optional/README.md b/optional/README.md
new file mode 100644
index 0000000..c039b85
--- /dev/null
+++ b/optional/README.md
@@ -0,0 +1,12 @@
+# Optional
+
+Poor man's optional "type templates" for C. Just for fun.
+
+In its current form it's intended to be used with "single token" types. Might
+or might not "make it compatible" with structs, enums, unions, etc. in the
+future, if the need arises.
+
+## Example usage
+
+If you want to see an example on how to use optional, take a look at
+`optional-test.c`.