-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added readme, updated include guard pattern
- Loading branch information
Showing
2 changed files
with
28 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
## Documentation | ||
|
||
This is a header-only library, as such most of its functional documentation is contained within the "header section" of the | ||
source code in the form of comments. It is highly recommended that you read said documentation before using this library. | ||
|
||
## Features | ||
|
||
The dvector library provides both common and more specialized 2D/3D vector math operations, its features include: | ||
|
||
- No hard dependencies besides the standard library, making it fully portable for most purposes | ||
- Provides vec2, vec3, vec4, quat, mat2, mat3, and mat4 types with various important operations | ||
- Supports an additional frst type along with frustum culling functions for spheres and AABBs | ||
- All dvector types are pass-by-value, allowing for easy use as arguments or return values | ||
|
||
## Attribution | ||
|
||
You are not required to give attribution when using this library. If you want to give attribution anyway, either link to | ||
this repository, [my website](https://www.slopegames.com/), or credit me as [BareRose](https://github.com/BareRose). | ||
If you want to support me financially, consider giving to my [Patreon](https://www.patreon.com/slopegames). | ||
|
||
## License | ||
|
||
Licensed under CC0 aka the most lawyer-friendly way of spelling "public domain". |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters