From 6dcd91913091a8178fe05550fc941bfd15a61247 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Sun, 14 Jan 2018 00:24:43 +0300 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3e6964a..f92b2c9 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,20 @@ Complete documentation is in progress: http://cglm.readthedocs.io If you don't aware about original GLM library yet, you may also want to look at: https://github.com/g-truc/glm +#### Note for new comers (Important): +- `vec4` and `mat4` variables must be aligned. (There will be unaligned versions later) +- **in** and **[in, out]** parameters must be initialized (please). But **[out]** parameters not, initializing out param is also redundant +- All functions are inline if you don't want to use pre-compiled versions with glmc_ prefix, you can ignore build process. Just incliude headers. +- if your debugger takes you to cglm headers then make sure you are not trying to copy vec4 to vec3 or alig issues... +- Welcome! + +#### Note for experienced developers: +- Since I'm testing this library in my projects, sometimes bugs occurs; finding that bug[s] and making improvements would be more easy with multiple developer/contributor and their projects or knowledge. Consider to make some tests if you suspect something is wrong and any feedbacks, contributions and bug reports are always welcome. + +#### Note for floating point errors: +I realized that floating point errors may occur is some operaitons especially decomposing matrices. cglm will support double later but I will try yo fix these errors by learning floating points standarts in more details. Currently it is just in my TODOs. + +