summaryrefslogtreecommitdiffstats
path: root/libraries/cglm/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/cglm/README')
-rw-r--r--libraries/cglm/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/libraries/cglm/README b/libraries/cglm/README
new file mode 100644
index 0000000000..47ac7047a0
--- /dev/null
+++ b/libraries/cglm/README
@@ -0,0 +1,17 @@
+cglm is a highly optimizied 2D and 3D graphics math library for the C
+programming language. The library provides many utilities to help math
+operations stay fast while remainging easy to write. cglm is based on
+the GLM math library that has bindings for the C++ programming
+language. The library is primarily used for operations with the OpenGL
+graphics API. The complete documentation is available at
+http://cglm.readthedocs.io/.
+
+Optional dependency: Sphinx (for building documentation)
+
+The following options are available with the following default values:
+ CGLM_SHARED=ON # Shared library build
+ CGLM_STATIC=OFF # Static library build
+ CGLM_USE_C99=OFF # Use C11 by default
+ CGLM_USE_TEST=OFF # For make check/test
+ CGLM_BUILD_DOCS=NO # Set to YES to build documentation using Sphinx
+ You will need the sphinx_rtd_theme PyPI package