aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2023-06-22 03:28:46 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2023-06-22 03:28:46 +0300
commit13cf037953a79def598b7842ebdc41a50275bbd9 (patch)
tree67a3edb1ee63f11d2f48cc16100ecccef03f2724 /README.md
parentdbf01c41e2a780318e440421d459a9cd86e18108 (diff)
downloadc-optional-13cf037953a79def598b7842ebdc41a50275bbd9.tar.gz
c-optional-13cf037953a79def598b7842ebdc41a50275bbd9.zip
README, LICENSE text, simple exampleHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6fa20e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# C Optional
+
+Poor man's optional "type templates" for C.
+
+In its current form it's intended to be used with "one word" types. Might
+or might not "make it compatible" with structs, enums, unions, etc. in the
+future, if the need arises.
+
+Just for fun.
+
+## Example usage
+
+If you want to see an example on how to use it, see `example.c`.