From: MarStr <marcus@marstr.online>
Date: Sat, 6 Jul 2024 09:11:37 +0000 (+0200)
Subject: Added README.md with details on the code.
X-Git-Url: http://marstr.online/code/gitweb.cgi?a=commitdiff_plain;h=946fe71ca1ccf28f39d8a84c9f4ed0f3de185f48;p=FileIO

Added README.md with details on the code.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5980b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+### MarStr FileIO for C++
+
+A simple class in the marstr namespace, which has many utility functions which help in dealing with reading from and writing to files. Writing a string for example is wrapped into a convenience call which also writes down the length of the string, prior to the string itself. Likewise, the call to read a string from a file reads the length of the string first, then the string itself is read.
+
+It comes with a number of datatypes that can be read from and written to, and should, in my opinion, cover many bases for file IO.
+
+Have a look at fileio.h to get all details.