Installation for MacOSX¶
Prerequisites for MacOSX users¶
If not already installed:
- Install Mercurial
- Optionally you can install TortoiseHg
- Install Python 2.7
- Install CMake
Tip
- You can also install Ninja instead of using make.
- For an easy install, you can use the Hombrew project to install missing packages.
FW4SPL installation¶
FW4SPL works with data separation for source, build and install data. To prepare the development environment:
- Create a development folder (Dev)
- Create a build folder (Dev\Build)
- Create a source folder (Dev\Src)
- Create a install folder (Dev\Install)
To prepare the third party environment:
- Create a third party folder (BinPkgs)
- Create a build folder (BinPkgs\Build)
- Create a source folder (BinPkgs\Src)
- Create a install folder (BinPkgs\Install)
Build tools¶
FW4SPL is a CMake project. That means, for each build target there is a CMakeLists that provides build parameters.
To configure you project you can use the cmake
command from the build folder with the sources as arguments:
ccmake /PATH/TO/fw4spl-deps
if you want to use Ninja as build to tools, use the option -G Ninja
, as following:
ccmake -G Ninja /PATH/TO/fw4spl-deps
It is the same process for BinPkgs and FW4SPL sources.
Dependencies¶
For the third party libraries the three following repositories have to be cloned in the (BinPkgs) source folder:
To build dependencies see Build tools instructions. Some CMake variables have to be change:
- ADDITIONAL_PROJECTS: set the source location of fw4spl-ar-deps and fw4spl-ext-deps
- CMAKE_INSTALL_PREFIX: set the install location.
Press configure ([c]) and generate ([g]) makefiles. Then, compile the FW4SPL dependencies with make or ninja in a terminal.
Source¶
For the FW4SPL source code the three following repositories have to be cloned in the (Dev) source folder:
To build soruces see Build tools instructions. Some CMake variables have to be change:
- ADDITIONAL_PROJECTS: set the source location of fw4spl-ar and fw4spl-ext
- CMAKE_INSTALL_PREFIX: set the install location.
- EXTERNAL_LIBRARIES: set the install path of the third part libraries.
Press configure ([c]) and generate ([g]) makefiles. Then, build dependencies with make or ninja in a terminal.
- example:
make Qt
orninja Qt
Launch an application¶
To build a specific or several applications the CMake argument PROJECTS_TO_BUILD
can be set.
Tip
Use ;
so separate each application name.
After an successful compilation the application can be launched with the launcher program from a terminal. Therefore the profile.xml of the application in the build folder has to be passed as argument to the launcher:
bin/launcher Bundles/MyApplicationAndVersion/profile.xml)
Note
To generate the projects in release, the following instruction has to be change:
- Change CMake argument
CMAKE_BUILD_TYPE
to release - Set the
EXTERNAL_LIBRARIES
to the release install folder of dependencies
Recommended softwares¶
The following programs may be helpful for your developments: