summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorScott Murray <scott.murray@konsulko.com>2019-10-20 11:30:15 -0400
committerScott Murray <scott.murray@konsulko.com>2019-10-20 13:16:26 -0400
commitd7d65ef59bd9e54787fdebebe39ea0d8e1155769 (patch)
tree26fc3bba8202707beddd2034ebaaecf8c6dd3b09 /README.md
parent1d3670c387c43f355f7190274085c55098fac90f (diff)
Fixes and rework to allow using with cluster demo
Changes include: - Remove older libhomescreen and qlibwindowmanager detection and configuration from qmake configuration in favor of PKGCONFIG usage. - Rework main.cpp to look more like ondemandnavi, and use qlibhomescreen instead of libhomescreen. - Update file_operation.{h,cpp} with the newer versions from ondemandnavi that include OSM configuration. - Fixed typo in arrived signal name in org.agl.naviapi.xml and dbus_client.cpp. - Change some qDebug messages in dbus_client.cpp to qWarning as it seems more appropriate. - Rework QtLocation plugin configuration in MapWindow.qml to support OSM and replace mapboxgl with mapbox, as mapboxgl does not seem to work out of the box. - Tweak various things in MapWindow.qml to try to better match the look of ondemandnavi. - Many commenting and whitespace fixes in MapWindow.qml. - Update widget config.xml to add now required display permission, and add the hidden permission so the application will not show up in the launcher. - Add license files for the various header files in include/mapbox, and update README.md to indicate where they come from and what files the different licenses apply to. Bug-AGL: SPEC-2913 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I192efd45ab94ace8234dbe6c8983257a24e51d23
Diffstat (limited to 'README.md')
-rw-r--r--README.md82
1 files changed, 59 insertions, 23 deletions
diff --git a/README.md b/README.md
index 3365abb..d953318 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,33 @@
-# tbtnavi
-
-#reference
-
+# tbtnavi
+Navigation application with turn by turn (TBT) navigation support for cluster demo remote display.
+## Reference
+The application is based on the QtLocation widget, documentation is available at:
+https://doc-snapshots.qt.io/qt5-5.9/qtlocation-index.html
+and example code used as a starting point at:
https://doc-snapshots.qt.io/qt5-5.9/qtlocation-mapviewer-example.html
-#build step
-
-source /SDK_PATH/environment-setup-aarch64-agl-linux
-
+## Build
+```
+source ${SDK_PATH}/environment-setup-aarch64-agl-linux
mkdir build
-
cd build
-
qmake ../
-
make
+```
+## Configuration
-#configuration
-
-This is the same file for navigation.
-If you have done it during install the navigation,please jump it.
+This is the same as the configuration file for the ondemandnavi navigation application. The same file will be used by both applications if present.
-Please set mapAccessToken, mapStyleUrl, speed,
-interval, latitude and longitude in JSON format
-in /etc/naviconfig.ini
+Please set mapAccessToken, mapStyleUrl, speed, interval, latitude and longitude in JSON format in `/etc/naviconfig.ini`.
-mapAccessToken sets Access token provided by Mapbox.
-speed sets vehicle speed in km / h.
-interval sets the screen update interval in milliseconds.
-latitude, longitute sets the current position at application start.
-mapStyleUrls sets Mapbox style URLs.
+- mapAccessToken sets Access token provided by Mapbox.
+- speed sets vehicle speed in km/h.
+- interval sets the screen update interval in milliseconds.
+- latitude, longitute sets the current position at application start.
+- mapStyleUrls sets Mapbox style URLs.
+### Example /etc/naviconfig.ini
+```
example
{
"mapAccessToken":"pk.***********",
@@ -40,4 +37,43 @@ example
"longitute":-115.151,
"mapStyleUrls":"mapbox://styles/mapbox/dark-v9"
}
+```
+## Licensing
+All files are Apache 2.0 licensed, except for those under include/mapbox.
+### From https://github.com/mapbox/cheap-ruler-cpp
+- include/mapbox/cheap_ruler.hpp
+
+ISC license (see LICENSE.mapbox-cheap-ruler-cpp)
+
+### From https://github.com/mapbox/geometry.hpp
+- feature.hpp
+- geometry.hpp
+- geometry_io.hpp
+- geometry/box.hpp
+- geometry/empty.hpp
+- geometry/envelope.hpp
+- geometry/for_each_point.hpp
+- geometry/geometry.hpp
+- geometry/line_string.hpp
+- geometry/multi_line_string.hpp
+- geometry/multi_point.hpp
+- geometry/multi_polygon.hpp
+- geometry/point_arithmetic.hpp
+- geometry/point.hpp
+- geometry/polygon.hpp
+
+ISC license (see LICENSE.mapbox-geometry.hpp)
+
+### From https://github.com/mapbox/variant
+- optional.hpp
+- variant_cast.hpp
+- variant.hpp
+- variant_io.hpp
+- variant_visitor.hpp
+
+BSD 3 Clause license (see LICENSE.mapbox-variant)
+
+- recursive_wrapper.hpp
+
+Boost 1.0 license per header comment (see LICENSE_1.0.txt)