Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Jan 12, 2022
1 parent 116ee7b commit e216275
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
3 changes: 1 addition & 2 deletions doc/basics/compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ $ make
$ make install
~~~

\note Running the `install` target is recommended as it will copy all the radium related library in the same place,
\note Running the `install` target is recommended as it will copy all the radium related library in the same place,
generate the cmake packages and bundle applications with their dependencies (on macos and windows).

Note that installation requires write access on the installation directory.
Expand Down Expand Up @@ -214,4 +214,3 @@ To fix it, edit `CMakeSettings.json`, such that

Right click on `CMakeList.txt > build > all`.
To install, you need to run any installation target, e.g. `Engine.dll (install)` or to select the menu `<Build>/<Install radiumproject>`

10 changes: 5 additions & 5 deletions doc/basics/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ Radium relies on several external libraries to load files or to represent some d
* stb_image

We developed a series of tools to fetch and compile easily these dependencies easily, except for
Qt, which needs to installed and passed to cmake through the variable `Qt5_DIR` (see documentation at
Qt, which needs to installed and passed to cmake through the variable `Qt5_DIR` (see documentation at
https://doc.qt.io/qt-5.12/cmake-manual.html#getting-started).

# Dependencies management systems

We offer three different systems to handle external dependencies (see details and how-to in the following sections):
1. **[recommended]** external build: the user compiles and installs once for all the dependencies using a dedicated
1. **[recommended]** external build: the user compiles and installs once for all the dependencies using a dedicated
cmake project. Then, Radium cmake project is configured to link with installed dependencies.
2. automatic build: the dependencies are automatically fetched and compiled by cmake when configuring Radium. This
automated process is handy for Continuous Integration systems. For standard users, it slows down the configuration
step of Radium and requires to fetch and recompile the dependencies each time the build directory is cleaned.
3. manual management: users can also provide their own version of the dependencies through cmake packages.
3. manual management: users can also provide their own version of the dependencies through cmake packages.

# Building and installing Radium dependencies once for all

We provide a standalone cmake project (`external/CMakeLists.txt`) to compile and install the Radium dependencies at any location
We provide a standalone cmake project (`external/CMakeLists.txt`) to compile and install the Radium dependencies at any location
_outside Radium-Engine source dir_.
\warning If you try to build and install external as a subdir of Radium-Engine source, cmake configuration will fail.

Expand Down Expand Up @@ -85,7 +85,7 @@ cmake \


# Fetch and build at configure time
When Radium is configured without specifying the paths to the dependencies, cmake automatically fetch, compile and
When Radium is configured without specifying the paths to the dependencies, cmake automatically fetch, compile and
install them.
\note In this mode, dependencies are fetched and built at **configure** time:

Expand Down

0 comments on commit e216275

Please sign in to comment.