Browse Source

Added note of required shared Urho3D library build if creating an application consisting of multiple modules.

Lasse Öörni 11 years ago
parent
commit
a7fef9291c
1 changed files with 2 additions and 0 deletions
  1. 2 0
      Docs/GettingStarted.dox

+ 2 - 0
Docs/GettingStarted.dox

@@ -128,6 +128,8 @@ To install the Urho3D library (or should we call it SDK), use the usual 'make in
 
 Refer to \ref UsingLibrary "Using Urho3D as external library" on how to setup your own project to use Urho3D as external library.
 
+Urho3D should be built as a shared library if your application consists of multiple modules (main executable + other shared libraries) that all link to Urho3D. The reason for this is that Urho3D contains a few sensitive static data values, such as the main thread's ID, which will not work properly if they are duplicated due to multiple static linkage.
+
 \section Building_Docs Documentation build
 
 If URHO3D_DOCS build option is set then a normal (ALL) build would not only build Urho3D software but also Urho3D documentation automatically. If it is not then the documentation can be generated by manually invoking 'make doc' command or its equivalent command in IDE.