From 866ee0594be2c8403ee6bb3cc5ec60f23408c0d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 19 Aug 2013 19:13:24 +0200 Subject: [PATCH] Link with other projects' building and usage documentation. --- Doxyfile | 5 ++++- README.md | 12 ++++++++---- doc/building.dox | 9 +++++++++ doc/cmake.dox | 2 ++ doc/namespaces.dox | 8 +++++++- 5 files changed, 30 insertions(+), 6 deletions(-) diff --git a/Doxyfile b/Doxyfile index 5efd5080d..d9dff7fed 100644 --- a/Doxyfile +++ b/Doxyfile @@ -142,7 +142,8 @@ STRIP_FROM_PATH = ../ # are normally passed to the compiler using the -I flag. 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 # (but less readable) file names. This can be useful if your file system @@ -688,6 +689,8 @@ INPUT = src/ \ doc/ \ ../magnum-plugins/src/ \ ../magnum-plugins/doc/ \ + ../magnum-integration/src/ \ + ../magnum-integration/doc/ \ ../magnum-examples/doc/ # This tag can be used to specify the character encoding of the source files diff --git a/README.md b/README.md index ad5263a61..33299aa2c 100644 --- a/README.md +++ b/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 if it doesn't exist yet. -PLUGINS AND EXAMPLES -==================== - -Various importer plugins for image and 3D model formats are maintained in +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. 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. There are also examples of engine usage, varying from simple *Hello World*-like diff --git a/doc/building.dox b/doc/building.dox index 1e6b77cea..caaca74dd 100644 --- a/doc/building.dox +++ b/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 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 In `package/archlinux` directory is currently one PKGBUILD for Git development diff --git a/doc/cmake.dox b/doc/cmake.dox index eee0944bc..6ebd791d6 100644 --- a/doc/cmake.dox +++ b/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 @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. */ } diff --git a/doc/namespaces.dox b/doc/namespaces.dox index f984f03b5..229abad25 100644 --- a/doc/namespaces.dox +++ b/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` 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 @@ -189,6 +191,8 @@ Font texture creation and text layouting. 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. +Additional plugins are part of plugin repository, see @ref building-plugins and +@ref cmake-plugins for more information. */ /** @dir TextureTools @@ -214,5 +218,7 @@ Contains plugin interfaces for importing data of various formats and classes for direct access to the data. 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. */