|
|
@@ -344,7 +344,7 @@ PROJECT_ROOT/
|
|
|
┕ *.bat or *.sh
|
|
|
\endcode
|
|
|
|
|
|
-The Source/ directory is where your project CMakeLists.txt and all your source codes should reside. The Bin/ directory is where all the executables output will be generated. In order to run the executable in this directory, you need to copy (or symlink) the CoreData/ and Data/ directories from Urho3D project Bin/ directory (or from Urho3D SDK installation) to here. You may also want to copy (or symlink) the batch files or shell script files from Urho3D project root directory (or from Urho3D SDK installation) to your project root directory. The Build/ directory will be created automatically by the Urho3D CMake module that will be discussed shortly below. The *.bat or *.sh scripts work together with the module to create a so-called out-of-source build tree to keep the Source/ directory clean from intermediate build files.
|
|
|
+The Source/ directory is where your project CMakeLists.txt and all your source codes should reside. The Bin/ directory is where all the executables output will be generated. In order to run the executable in this directory, you need to copy (or symlink) the CoreData/ and Data/ directories from Urho3D project Bin/ directory (or from Urho3D SDK installation) to here. You may also want to copy (or symlink) the batch files or shell script files from Urho3D project root directory (or from Urho3D SDK installation) to your project root directory. The Build/ directory will be created automatically by the Urho3D CMake module that will be discussed shortly below. The *.bat or *.sh scripts work together with the module to create a so-called out-of-source build tree to keep the Source/ directory clean from intermediate build files. Note that when you invoke one the *.bat or *.sh script, you can pass most of the \ref Build_Options "build options" supported by Urho3D project. In fact, you probably have to pass the similar build options that you use when building the Urho3D library to avoid any conflict.
|
|
|
|
|
|
\section UsingLibraryFromProjectRootTree From Urho3D project root tree
|
|
|
|
|
|
@@ -445,6 +445,17 @@ export PKG_CONFIG_PATH=${RASPI_ROOT}/usr/local/lib/pkgconfig
|
|
|
$CC -o Urho3DPlayer Urho3DPlayer.cpp `pkg-config --cflags --libs Urho3D`
|
|
|
\endcode
|
|
|
|
|
|
+\section Scaffolding Project scaffolding
|
|
|
+
|
|
|
+On Unix-like build/host system (Linux, Mac, Raspberry-Pi) with [Rake](https://rubygems.org/gems/rake) ruby gem installed, you can quickly setup all the above by simply using the 'scaffolding' rake task.
|
|
|
+\verbatim
|
|
|
+Usage: rake scaffolding dir=/path/to/new/project/root [project=Scaffolding] [target=Main]
|
|
|
+\endverbatim
|
|
|
+
|
|
|
+As its name implies, this task just creates a basic project structure for your new project. You may also pass optional "project" and "target" parameters besides the "dir" parameter. Otherwise, you will get the default project name (Scaffolding) and target name (Main) in the main CMakeLists.txt. This task copies the Urho3DPlayer.cpp and Urho3DPlayer.h as placeholders for the source files. Normally, you should replace these two files with your own project source files before invoking one of the CMake *.bat or *.sh script.
|
|
|
+
|
|
|
+Unfortunately, all our rake tasks are currently not supported on Windows build/host system yet.
|
|
|
+
|
|
|
\page Structure Overall structure
|
|
|
|
|
|
The Urho3D engine compiles into one library. Conceptually it consists of several "sublibraries" that represent different subsystems or functionality. Each of these resides in a subdirectory
|