aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMikhail Romanko <me@blankhex.com>2025-01-18 18:48:40 +0300
committerMikhail Romanko <me@blankhex.com>2025-01-18 18:48:40 +0300
commit881ffc87f9841e96b8dd1211225146a11d8af0b3 (patch)
treeaaea194bb9c422f23f3f1ecad1533cdfc4f472f1
parent453843f51a13f12ceb28553d05147dd03ff2c1b6 (diff)
downloadbhlib-881ffc87f9841e96b8dd1211225146a11d8af0b3.tar.gz
Add readme and license file
Readme file contains implemented and future features. License file is a license file.
-rw-r--r--LICENSE12
-rw-r--r--README26
2 files changed, 38 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8365d93
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,12 @@
+Copyright (c) 2025 by Mikhail Romanko
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
+DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
new file mode 100644
index 0000000..39e38b4
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+BlankHex Library
+
+Library with a bunch of stuff.
+
+Currently implemented:
+- I/O device abstraction
+- File access (Windows and POSIX)
+- Data structures (hashmap, queue)
+- Algorithms (swap, sort, partition, heap)
+- Geometry math (2D/3D/4D vectors, matrices, quaternions)
+- Unit tests
+
+Future plans:
+- More geometry stuff (boxes, rays, planes, lines, triangles, etc.)
+- Thread support (thread, mutex, cv, atomics, etc.)
+- Image loading/processing/saving support
+- Polygon rasterization (possibly canvas)
+- UTF8 string support (BMP handling)
+- Font rendering
+- GUI (Windows GUI oriented, X11)
+- Deflate/Inflate implementation
+- Audio loading/processing/saving support
+- FFT/IFFT (with basic complex numbers)
+- Basic 2D/3D physics engine (possibly as a separate library?)
+- Configuration support (INI, JSON, Registry)
+- More unit tests