From b4a7d1a6fd7a55ff70e90229c9e47f3d12776e0a Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 18 Nov 2021 22:49:29 +0100 Subject: [PATCH] Add SUPPORT.rst file --- README.rst | 3 ++- SUPPORT.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 SUPPORT.rst diff --git a/README.rst b/README.rst index 067e8a36..9e7ef99c 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,7 @@ Building Coriolis To build Coriolis, ensure the following prerequisites are met: -* Python 2.7 or 3. +* Python 3. * cmake. * boost. * bison & flex. @@ -65,6 +65,7 @@ Then, build the tool: :: ego@home:coriolis$ make install +If you encounter issues, please consult SUPPORT.rst for tips. Coriolis gets installed at the root of the following tree: :: ~/coriolis-2.x/./Release.Shared/install/ diff --git a/SUPPORT.rst b/SUPPORT.rst new file mode 100644 index 00000000..ec1ca8e3 --- /dev/null +++ b/SUPPORT.rst @@ -0,0 +1,27 @@ + +================= +Help and tooltips +================= + + +Compilation errors +================== + +This section is here to help you with the build process, and help you fix dependency issues or workaround compilation errors if it happens on your distribution. + + +RapidJson +--------- + +Some versions of RapidJson do not build with newer compilers, while others build only with newer ones. +The version provided in README.rst should work for older compilers. Otherwise, consider pulling a newer version. + +Qt5 +--- + +To use Qt5, you should add the --qt5 option to the ccb.py line in Makefile. +On some distributions, you may need to replace the lines in bootstrap/cmake_modules/FindBootstrap.cmake from :: + find_package(Qt5Core REQUIRED) +to :: + find_package(Qt5 COMPONENTS REQUIRED Core) +