libutil

meta: Add readme

Diffstat

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..27932d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# OMKOV lib
+
+> OMKOV local library
+
+OMKOV lib is a lightweight generic library to be included locally in projects.
+
+## Components
+
+| Component        | Description                                         |
+| ---------------- | --------------------------------------------------- |
+| error            | Print formatted error messages                      |
+| mode             | Parse numeric or symbolic POSIX modes               |
+| optget           | Parse arguments                                     |
+
+## Build Instructions
+
+OMKOV lib uses CMake to build.  
+Binaries will be located in the `bin` directory.
+Libraries will be located in the `lib` directory.
+
+### UNIX Build
+
+Run `BuildUNIX.sh`, or
+
+```sh
+cmake -S . -B build && cmake --build build
+```
+
+## Meta
+
+Copyright (C) 2020, Jakob Wakeling  
+All rights reserved.  
+[OMKOV Permissive Licence](https://www.omkov.net/OLPE)