Add README.md

README.md

@@ -0,0 +1,27 @@
+# libsctimer — Set (possibly reapeating) alarms
+
+Handle any alarms in a function inside its own thread.
+
+This library is a lightweight C++-wrapper around POSIX timers, and as such only
+works on Linux, because, currently, the POSIX timer APIs have not been
+implemented on macOS or OpenBSD.
+
+## Build
+
+`make`
+
+after building and installing the dependency:
+
+- [libscerror](https://git.bobpolis.com/bob/libscerror/)
+
+## Install
+
+`sudo make install`
+
+or, on OpenBSD:
+
+`doas gmake install`
+
+## Documentation
+
+Not yet available.