aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMikhail Romanko <me@blankhex.com>2025-02-28 21:44:01 +0300
committerMikhail Romanko <me@blankhex.com>2025-02-28 21:44:22 +0300
commita2d0913c79880e2bf70539015686bab40108fb0d (patch)
tree9445732b7bb33f7691275605f72f44d8d7afbe01 /README.md
parent93033ebc99442038ab137710bbd4014a249e75c8 (diff)
downloadbhlib-a2d0913c79880e2bf70539015686bab40108fb0d.tar.gz
Add utils for working with endianness, more documentation, refactor CMake
Decided to update the docs, as well as adding few new features and small refactoring.
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f283547
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# BHLib
+
+Library with a bunch of stuff
+
+## About
+
+Here is a short list of implemented features:
+
+- Abstraction over input/output
+- Basic data structures and algorithms (hashmap, queue, heaps, partitions)
+- Geomtric primitives (vectors, matrices, quaternions, rays, boxes)
+
+For more information about currently implemented and planned features checkout
+[this page](doc/Features.md)
+
+## Docs
+
+The documentation for the functions is provided in the form of Doxygen comments.
+
+The [HowTo guides](doc/HowTo.md) are also available.
+
+## License
+
+BHLib is licensed under [0BSD License](https://opensource.org/license/0bsd).
+This means that you can:
+
+- Use this library in personal or commercial projects
+- Freely redistribute library in either source or binary forms without
+ copyright notice
+- Modify and relicense your version/fork of the library