From c12458e9967c87c1169c12c0839a8b794a9ba3fb Mon Sep 17 00:00:00 2001 From: Fred Hornsey Date: Thu, 6 Sep 2018 15:53:46 -0500 Subject: [PATCH] Common Qt Documentation File --- docs/qt.md | 46 +++++++++++++++++++++++++++++++++ examples/DCPS/ishapes/README.md | 2 +- tools/monitor/README.md | 31 +++++----------------- 3 files changed, 54 insertions(+), 25 deletions(-) create mode 100644 docs/qt.md diff --git a/docs/qt.md b/docs/qt.md new file mode 100644 index 00000000000..ab5a00514c8 --- /dev/null +++ b/docs/qt.md @@ -0,0 +1,46 @@ +# Configuring for Qt5 OpenDDS Applications + +Some included OpenDDS applications require Qt5: + + - ishapes demo + - OpenDDS Monitor + - ExcelRTD + - (Indirectly through dependence on some of Monitor's functionality) + +To build and use these applications, Qt5 must be available on the system and +Qt5 support must be enabled in the build system. + +## Qt5 + +Qt5 is freely available from [qt.io](https://qt.io) or through your system's +package manager: + + - `qtbase5-dev` on Ubuntu + - `qt5-qtbase-devel` on Fedora + - Windows and macOS would probably be best served by downloading it from [qt.io](https://qt.io) + +Any instance of Qt5 would work as long as it is built and has the headers +and basic Qt development tools. + +## If Using the Configure Script + +If using the configure script, supply the `--qt` option. If your Qt was +downloaded from source or installed in a specific place (the case for prebuilt +binaries on Windows), you will need to supply the root of the Qt directory so +the build system can find the Qt tools, libraries, and headers. It's possible +for Qt to put in it's headers in a sub directory of the include directory, +so the location can be supplied with `--qt-include`. This is the case on +x86\_64 Ubuntu 18.04 with Qt5 installed from apt, which places them at +`/usr/include/x86_64-linux-gnu/qt5`. +In that case the options whould be +`--qt --qt-include /usr/include/x86_64-linux-gnu/qt5` +because the tools and libraries are in the standard locations but the headers +are not. + +## Without the Configure Script + +Even if not using the configure script, all of the same things apply except + + - The `qt5` feature must be enabled in MPC + - `$QTDIR` must be set and corresponds to the `--qt` configure script option + - `$QT5_INCDIR` corresponds to the `--qt-include` configure script option diff --git a/examples/DCPS/ishapes/README.md b/examples/DCPS/ishapes/README.md index ea7fe36daae..0126bb4103c 100644 --- a/examples/DCPS/ishapes/README.md +++ b/examples/DCPS/ishapes/README.md @@ -15,7 +15,7 @@ concepts by making use of the included application. ishapes requires the core OpenDDS libraries so make sure you are able to build them before attempting to build ishapes. It also uses Qt5. To configure Qt5 applications in OpenDDS, please follow the -[OpenDDS Qt5 documentation (DDS\_ROOT/docs/qt5.md)](../../../docs/qt5.md). +[OpenDDS Qt5 documentation (DDS\_ROOT/docs/qt.md)](../../../docs/qt.md). Once configured, ishapes should be able to be built using the target/project named `ishapes` but will also be built by default if everything is being built. diff --git a/tools/monitor/README.md b/tools/monitor/README.md index f75e4f7d425..c81f3eee1bb 100644 --- a/tools/monitor/README.md +++ b/tools/monitor/README.md @@ -10,30 +10,13 @@ monitor is running. ## Building -The monitor relies on OpenDDS so make sure you are able to build that before -attempting to build the monitor. It also uses Qt5, which is freely available -from [qt.io](https://qt.io) or through your system's package manager. - -If using the configure script, supply the `--qt` option. If your Qt was -downloaded from source or installed in a specific place (the case for prebuilt -binaries on Windows), you will need to supply the root of the Qt directory so -the build system can find the Qt tools, libraries, and headers. It's possible -for Qt to put in it's headers in a sub directory of the include directory, -so the location can be supplied with `--qt-include`. This is the case on -x86\_64 Ubuntu 18.04 with Qt5 installed from apt, which places them at -`/usr/include/x86_64-linux-gnu/qt5`. -In that case the options whould be -`--qt --qt-include /usr/include/x86_64-linux-gnu/qt5` -because the tools and libraries are in the standard locations but the headers -are not. - -If not using the configure script then: - - - The `qt5` feature must be enabled - - `$QTDIR` must be set and corresponds to the `--qt` configure script option - - `$QT5_INCDIR` corresponds to the `--qt-include` configure script option - -Once configured, it can be built using the same methods as OpenDDS. +The monitor requires the core OpenDDS libraries so make sure you are able to +build them first. It also uses Qt5. +To configure Qt5 applications in OpenDDS, please follow the +[OpenDDS Qt5 documentation (DDS\_ROOT/docs/qt.md)](../../../docs/qt.md). +Once configured, the mointor should be able to be built using the +target/project named `MonitorApp` but will also be built by default if +everything is being built. ## Usage