From 7ce8a7d868ad489cc5dbe6f35e1fdedd075c3aea Mon Sep 17 00:00:00 2001
From: Bob Polis <bob.polis@gmail.com>
Date: Fri, 29 Nov 2024 09:49:10 +0100
Subject: [PATCH] Add README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d728348
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# libscio — Custom C++ I/O streams and general I/O utilities
+
+Support for:
+
+- POSIX file descriptors
+- sockets
+- reading/writing values in a different byte order than the native one
+- reading from memory mapped files
+
+## Build
+
+`make`
+
+after building and installing the dependency:
+
+- [libscerror](httos://git.bobpolis.com/bob/libscerror/)
+
+## Install
+
+`sudo make install`
+
+or, on OpenBSD:
+
+`doas gmake install`
+
+## Documentation
+
+Not yet available.