Skip to content

Commit

Permalink
Common Qt Documentation File
Browse files Browse the repository at this point in the history
  • Loading branch information
iguessthislldo committed Sep 6, 2018
1 parent 084d955 commit c12458e
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 25 deletions.
46 changes: 46 additions & 0 deletions docs/qt.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion examples/DCPS/ishapes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
31 changes: 7 additions & 24 deletions tools/monitor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit c12458e

Please sign in to comment.