1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..42471d0
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+nihil: C++ utility library
+==========================
+
+nihil is a C++ library which provides various utilities that might be useful
+in a C++ program.  many of the utilities are specific to FreeBSD.
+
+i wrote this primarily for my own programs, but you're welcome to use it too.
+
+license
+-------
+
+all of nihil is in the public domain, with the exception of:
+
+- nihil/generator.ccm (BSL)
+- nihil/monad.ccm (MIT)
+- nihil/uuid.ccm (MIT)
+
+requirements
+------------
+
++ FreeBSD
++ a modern C++ compiler.  nihil is tested using LLVM 19.x with -std=c++26.
+
+usage
+-----
+
+nihil is intended to be consumed as a CMake subdirectory.  better install
+options might be added later.