summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2022-10-24 21:04:00 +0200
committerJörg Frings-Fürst <debian@jff-webhosting.net>2022-10-24 21:04:00 +0200
commit3422d8db505630a70bc89a4eee7db927b8e5ec2f (patch)
treef0c6e1ba7db9991f2bd38c9169f9921bfe5e61d8 /README.rst
parentdf5167db909a88fb8e16dd20b37442495a6ac059 (diff)
parentaab49e5a013c53ae812a143fe41add74e0677a61 (diff)
Merge branch 'feature/upstream' into develop
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>`_.