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.
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user