The instructions are currently written for experts. It needs to be clearer to programming beginners how to build spirit.
Building the Core Library should state explicitly what the core library is and that it is not the spirit GUI.
Building Framework Components should explicitly state at the top which components the framework includes and that all of them require the core library and that (almost) all can be built at the same time.
It is important to clearly describe how to build the OpenMP and CUDA versions of the core library.
It would be better to split it in two (Unix/OSX and Windows) and structure as follows:
customization of features using cmake options, e.g. -DSPIRIT_USE_CUDA=ON and corresponding prerequisites
It should be clear how to set the compiler and build options when using CMake.
It should also be clear which QT package should be installed ("gcc_...").
Windows
basic prerequisites (cmake, VS, QT with charts) and changing the PATH variable
customization of features using cmake options, e.g. -DSPIRIT_USE_CUDA=ON and corresponding prerequisites or using the CMake GUI
It should be clear what needs to be installed and how to change the PATH variable, both for QT and CUDA. It should also be clear which QT package should be installed ("msvc_...").
It should also be clear that there are two recommended/documented ways to build (command line or GUI), but others exist (msys, ninja, etc).
Note that WIndows does not have proper OpenMP support, so there is no docs for how to build that version.
The instructions are currently written for experts. It needs to be clearer to programming beginners how to build spirit. Building the Core Library should state explicitly what the core library is and that it is not the spirit GUI. Building Framework Components should explicitly state at the top which components the framework includes and that all of them require the core library and that (almost) all can be built at the same time.
It is important to clearly describe how to build the OpenMP and CUDA versions of the core library.
It would be better to split it in two (Unix/OSX and Windows) and structure as follows:
Unix
cmake
, compiler, qt, qt-charts & maybe OpenGL drivers)cmake
,make
/cmake --build
)-DSPIRIT_USE_CUDA=ON
and corresponding prerequisitesIt should be clear how to set the compiler and build options when using CMake. It should also be clear which QT package should be installed ("gcc_...").
Windows
cmake
, VS, QT with charts) and changing the PATH variablecmake
/CMake GUI,make
/cmake --build
/Open in VS)-DSPIRIT_USE_CUDA=ON
and corresponding prerequisites or using the CMake GUIIt should be clear what needs to be installed and how to change the PATH variable, both for QT and CUDA. It should also be clear which QT package should be installed ("msvc_...").
It should also be clear that there are two recommended/documented ways to build (command line or GUI), but others exist (msys, ninja, etc).
Note that WIndows does not have proper OpenMP support, so there is no docs for how to build that version.