summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3ac5e61
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,8 @@
+libHX collects many useful day-to-day functions, intended to reduce the amount
+of otherwise repeatedly open-coded instructions.
+
+It has maps, deques, linked lists, string formatting and autoresizing, option
+and config file parsing, type checking casts (for C), directory traversal, etc.
+
+There is more documentation in the aptly-named directory ``doc``.
+The entrypoint is `doc/libHX_Documentation.rst <doc/libHX_Documentation.rst>`_.