Browse Source

Mentioned online docs and unit tests in documentation.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
e62091d968
  1. 19
      README.md
  2. 5
      doc/MainPage.dox

19
README.md

@ -2,20 +2,23 @@ Magnum is 3D graphics engine written in C++11 and OpenGL 3 Core Profile.
Features: Features:
* Easy-to-use templated mathematical library for matrix/vector calculations. * Easy-to-use templated mathematical library for matrix/vector calculations.
* Comprehensive use of C++11 features for safety, performance and ease of
development.
* Hierarchical scene graph which supports transformation caching for better * Hierarchical scene graph which supports transformation caching for better
performance, classes for convenient usage of shaders, buffers and textures. performance, classes for convenient usage of shaders, buffers and textures.
* Mesh tools for cleaning, optimizing and generating meshes. Collection of * Mesh tools for cleaning, optimizing and generating meshes. Collection of
pre-made graphic primitives and shaders for testing purposes. pre-made graphic primitives and shaders for testing purposes.
* Comprehensive use of C++11 features for safety, performance and ease of
development. All code which doesn't directly interact with OpenGL is
covered with unit tests.
* Actively maintained Doxygen documentation. Occasionally updated snapshot is
also available online at http://mosra.cz/blog/magnum-doc .
INSTALLATION INSTALLATION
============ ============
You can either use packaging scripts, which are stored in package/ You can either use packaging scripts, which are stored in package/
subdirectory, or compile and install everything manually. Note that Doxygen subdirectory, or compile and install everything manually. Note that Doxygen
documentation contains more comprehensive guide for building, packaging and documentation (see above or build your own using instructions below) contains
crosscompiling. more comprehensive guide for building, packaging and crosscompiling.
Minimal dependencies Minimal dependencies
-------------------- --------------------
@ -53,10 +56,10 @@ in build directory. Everything should pass ;-)
Building documentation Building documentation
---------------------- ----------------------
The documentation (which you are currently reading) is written in **Doxygen** The documentation is written in **Doxygen** (version 1.8 with Markdown support
(preferrably 1.8 with Markdown support, but older versions should do good job is used, but older versions should do good job too) and additionally uses
too) and additionally uses **Graphviz** for class diagrams. The documentation **Graphviz** for class diagrams and **TeX** for math formulas. The
can be build by running documentation can be build by running:
doxygen doxygen

5
doc/MainPage.dox

@ -6,8 +6,6 @@ Features:
- Easy-to-use templated @ref Math "mathematical library" for matrix/vector - Easy-to-use templated @ref Math "mathematical library" for matrix/vector
calculations. calculations.
- Comprehensive use of C++11 features for safety, performance and ease of
development.
- Hierarchical @ref Scene "scene graph" which supports transformation caching - Hierarchical @ref Scene "scene graph" which supports transformation caching
for better performance, classes for convenient usage of for better performance, classes for convenient usage of
@ref AbstractShaderProgram "shaders", @ref Buffer "buffers" and @ref AbstractShaderProgram "shaders", @ref Buffer "buffers" and
@ -15,6 +13,9 @@ Features:
- @ref MeshTools "Mesh tools" for cleaning, optimizing and generating meshes. - @ref MeshTools "Mesh tools" for cleaning, optimizing and generating meshes.
Collection of pre-made @ref Primitives "graphic primitives" and Collection of pre-made @ref Primitives "graphic primitives" and
@ref Shaders "shaders" for testing purposes. @ref Shaders "shaders" for testing purposes.
- Comprehensive use of C++11 features for safety, performance and ease of
development. All code which doesn't directly interact with OpenGL is
covered with unit tests.
The engine is meant to be run on OpenGL 3 capable hardware, but most of the The engine is meant to be run on OpenGL 3 capable hardware, but most of the
functionality is working on OpenGL 2.1 hardware too. See also functionality is working on OpenGL 2.1 hardware too. See also

Loading…
Cancel
Save