From 1fe65522c92446636affcdeaedbd84dffe772413 Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Fri, 1 May 2015 15:46:53 +0200 Subject: [PATCH] Added GLM description to GLM readme.md --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/readme.md b/readme.md index 5b392f83..ce6a6713 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,21 @@ ![glm](doc/logo.png) +*OpenGL Mathematics (GLM) is a header only C++ mathematics library for graphics software based on the [OpenGL Shading Language (GLSL) specifications](https://www.opengl.org/registry/doc/GLSLangSpec.4.50.diff.pdf). +*GLM provides classes and functions designed and implemented with the same naming conventions and functionalities than GLSL so that anyone who knows GLSL, can use GLM as well in C++. +*This project isn't limited to GLSL features. An extension system, based on the GLSL extension conventions, provides extended capabilities: matrix transformations, quaternions, data packing, random numbers, noise, etc... +*This library works perfectly with OpenGL but it also ensures interoperability with other third party libraries and SDK. It is a good candidate for software rendering (raytracing / rasterisation), image processing, physic simulations and any development context that requires a simple and convenient mathematics library. +*GLM is written in C++98 but can take advantage of C++11 when supported by the compiler. It is a platform independent library with no dependence and it officially supports the following compilers: +- Apple Clang 4.0 and higher +- GCC 4.2 and higher +- Intel C++ Composer XE 2013 and higher +- LLVM 3.0 and higher +- Visual C++ 2010 and higher +- CUDA 4.0 and higher (experimental) +- Any conform C++98 or C++11 compiler +*For more information about GLM, please have a look at the manual and the API reference documentation. +*The source code and the documentation, including this manual, are licensed under the [Happy Bunny License (Modified MIT) and the MIT License](./copying.txt). +*Thanks for contributing to the project by [submitting issues](https://github.com/g-truc/glm/issues) for bug reports and feature requests. Any feedback is welcome at [glm@g-truc.net](mailto://glm@g-truc.net). + ================================================================================ OpenGL Mathematics (GLM) --------------------------------------------------------------------------------