diff options
Diffstat (limited to 'platform/qt/README.md')
| -rw-r--r-- | platform/qt/README.md | 46 |
1 files changed, 3 insertions, 43 deletions
diff --git a/platform/qt/README.md b/platform/qt/README.md index dc17d69903..22c06310c3 100644 --- a/platform/qt/README.md +++ b/platform/qt/README.md @@ -3,43 +3,10 @@ [](https://travis-ci.org/mapbox/mapbox-gl-native/builds) [](https://www.bitrise.io/app/96cfbc97e0245c22) -Provides [Qt](http://www.qt.io/) example applications and APIs via `QMapboxGL` -and `QQuickMapboxGL`: - -**QMapboxGL** - implements a C++03x-conformant API that has been tested from Qt -4.7 onwards (Travis CI currently builds it using both Qt 4 and Qt 5). - -**QQuickMapboxGL** - implements a Qt Quick (QML) item that can be added to a -scene. Because `QQuickFramebufferObject` has been added in Qt version 5.2, we -support this API from this version onwards. - - - ### Developing -[Qt supports many platforms](https://www.qt.io/qt-framework/#section-4) - so far -we have been testing our code on Linux and macOS desktops, as well as embedded -devices such as Raspberry Pi 3. - -If you need to maintain backwards compatibility with prior releases of -Qt, chose `QMapboxGL`. Otherwise, go for `QQuickMapboxGL`. - -Both `QMapboxGL` and `QQuickMapboxGL` requires a [Mapbox access -token](https://www.mapbox.com/help/define-access-token/) at runtime - you need -to provide it by setting the environment variable `MAPBOX_ACCESS_TOKEN`: - - export MAPBOX_ACCESS_TOKEN=MYTOKEN - -Optionally, you can specify a custom style to the QMapboxGL example application: - - export MAPBOX_STYLE_URL=MYSTYLEURL - -#### Using QMapboxGL - -`QMapboxGL` is a [QObject](http://doc.qt.io/qt-5/qobject.html) - [MapWindow](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/qt/app/mapwindow.hpp) provides an example [QGLWidget](http://doc.qt.io/qt-5/qglwidget.html) that contains a `QMapboxGL` object. If you use `QMapboxGL` in non-standard Qt widgets, make sure to initialize the GL extensions required by Mapbox whenever possible: - - QMapbox::initializeGLExtensions(); +This is the foundation for the Mapbox GL plugin available since Qt 5.9. Use the Qt bugtracker +for bugs related to the plugin and this GitHub repository for bugs related to Mapbox GL Native. #### Linux @@ -47,9 +14,7 @@ For Linux (Ubuntu) desktop, together with these [build instructions](https://github.com/mapbox/mapbox-gl-native/tree/master/platform/linux#build), you also need: - sudo apt-get install qt5-default qtlocation5-dev qtpositioning5-dev \ - qml-module-qtquick2 qml-module-qtpositioning qml-module-qtgraphicaleffects \ - qml-module-qtquick-layouts qml-module-qtquick-controls + sudo apt-get install qt5-default #### macOS @@ -74,8 +39,3 @@ can be found in [platform/qt/include](https://github.com/mapbox/mapbox-gl-native ```make qt-app``` or ```make run-qt-app``` to run the application at the end of build. - -#### QQuickMapboxGL example application: - -```make qt-qml-app``` or ```make run-qt-qml-app``` to run the application at the -end of build. |