Browse Source

Link with other projects' building and usage documentation.

pull/23/head
Vladimír Vondruš 13 years ago
parent
commit
866ee0594b
  1. 5
      Doxyfile
  2. 12
      README.md
  3. 9
      doc/building.dox
  4. 2
      doc/cmake.dox
  5. 8
      doc/namespaces.dox

5
Doxyfile

@ -142,7 +142,8 @@ STRIP_FROM_PATH = ../
# are normally passed to the compiler using the -I flag. # are normally passed to the compiler using the -I flag.
STRIP_FROM_INC_PATH = ../magnum/src \ STRIP_FROM_INC_PATH = ../magnum/src \
../magnum-plugins/src ../magnum-plugins/src \
../magnum-integration/src
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful if your file system # (but less readable) file names. This can be useful if your file system
@ -688,6 +689,8 @@ INPUT = src/ \
doc/ \ doc/ \
../magnum-plugins/src/ \ ../magnum-plugins/src/ \
../magnum-plugins/doc/ \ ../magnum-plugins/doc/ \
../magnum-integration/src/ \
../magnum-integration/doc/ \
../magnum-examples/doc/ ../magnum-examples/doc/
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files

12
README.md

@ -122,10 +122,14 @@ in root directory (i.e. where `Doxyfile` is). Resulting HTML documentation
will be in `build/doc/` directory. You might need to create `build/` directory will be in `build/doc/` directory. You might need to create `build/` directory
if it doesn't exist yet. if it doesn't exist yet.
PLUGINS AND EXAMPLES RELATED PROJECTS
==================== ================
Various importer plugins for image and 3D model formats are maintained in The engine itself is kept as small as possible with only little dependencies.
Additional functionality, often depending on external libraries, is provided in
separate repositories. Integration with various external math and physics
libraries can be found at https://github.com/mosra/magnum-integration. Various
importer plugins for image, audio and 3D model formats are maintained in
separate repository, which can be found at https://github.com/mosra/magnum-plugins. separate repository, which can be found at https://github.com/mosra/magnum-plugins.
There are also examples of engine usage, varying from simple *Hello World*-like There are also examples of engine usage, varying from simple *Hello World*-like

9
doc/building.dox

@ -216,6 +216,15 @@ in root directory (i.e. where `Doxyfile` is). Resulting HTML documentation
will be in `build/doc/` directory. You might need to create `build/` directory will be in `build/doc/` directory. You might need to create `build/` directory
if it doesn't exist yet. if it doesn't exist yet.
@section building-related Related projects
The engine itself is kept as small as possible with only little dependencies.
Additional functionality, often depending on external libraries, is provided in
separate repositories. Various importer plugins for image, audio and 3D model
formats are maintained in @ref building-plugins "Plugins repository",
Integration with various external math and physics libraries is provided by
@ref building-integration "Integration library".
@section building-arch Building ArchLinux packages @section building-arch Building ArchLinux packages
In `package/archlinux` directory is currently one PKGBUILD for Git development In `package/archlinux` directory is currently one PKGBUILD for Git development

2
doc/cmake.dox

@ -106,6 +106,8 @@ are also available as preprocessor variables if including Magnum.h:
%Corrade library provides also its own set of CMake macros and variables, see %Corrade library provides also its own set of CMake macros and variables, see
@ref corrade-cmake "its documentation" for more information. @ref corrade-cmake "its documentation" for more information.
@ref cmake-plugins "Plugins repository" and @ref cmake-integration "Integration library"
have also their own CMake modules.
*/ */
} }

8
doc/namespaces.dox

@ -98,6 +98,8 @@ Audio import, playback and integration with @ref SceneGraph.
This library is built when `WITH_AUDIO` is enabled and found as `%Audio` This library is built when `WITH_AUDIO` is enabled and found as `%Audio`
component in CMake. See @ref building and @ref cmake for more information. component in CMake. See @ref building and @ref cmake for more information.
Additional plugins are part of plugin repository, see @ref building-plugins and
@ref cmake-plugins for more information.
*/ */
/** @dir DebugTools /** @dir DebugTools
@ -189,6 +191,8 @@ Font texture creation and text layouting.
This library is built when `WITH_TEXT` is enabled and found as `%Text` This library is built when `WITH_TEXT` is enabled and found as `%Text`
component in CMake. See @ref building and @ref cmake for more information. component in CMake. See @ref building and @ref cmake for more information.
Additional plugins are part of plugin repository, see @ref building-plugins and
@ref cmake-plugins for more information.
*/ */
/** @dir TextureTools /** @dir TextureTools
@ -214,5 +218,7 @@ Contains plugin interfaces for importing data of various formats and classes
for direct access to the data. for direct access to the data.
This library is built by default and found by default in CMake. See This library is built by default and found by default in CMake. See
@ref building and @ref cmake for more information. @ref building and @ref cmake for more information. Additional plugins are part
of plugin repository, see @ref building-plugins and @ref cmake-plugins for more
information.
*/ */

Loading…
Cancel
Save