init: makefile, readme and clang bs

1 files changed, 17 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b7e376f
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+# sfinae
+
+Substitution Failure Is Not An Error. Everything else is.
+A toy language which takes' C++ template metaprogramming to another level.
+
+## build
+
+    make            release build, ./sfinae in the root, objects in bin/
+    make debug      rebuild with address and undefined sanitizers
+    make check      run examples/ against their .expected files
+    make format     clang-format the sources
+    make lint       clang-tidy naming check
+    make clean
+
+## run
+
+    ./sfinae examples/hello.sfinae