Initial commit

README.md

@@ -0,0 +1,32 @@
+# ht
+
+ht (official name is lowercase) is a hash table library written in standard
+C99. It takes inspiration from the [GLib GHashTable
+type](https://docs.gtk.org/glib/struct.HashTable.html).
+
+For examples of usage, see `test/test_ht.c`.
+
+### Building
+
+CMake is the only dependency as it is nessesary for building.
+
+```sh
+cmake -B build
+make -C build
+```
+
+Once built, you can run tests with
+
+```sh
+make -C build test
+```
+
+### Documentation
+
+you can build documentation with:
+
+```
+doxygen
+```
+
+The generated documentation is available in the `docs/` directory.