README

Traprain
========

Traprain is a set of libraries allowing navigation services, such as a car
GPS routing application, to share navigation and routing information to third
party applications.

This module provides the following libraries:
- traprain-service: used by navigation services to publish potential and
  current navigation routes. It also allows those service to publish
  information about the current journey such as its start and estimated end time.
  Also provides API to send turn-by-turn notifications to the UI responsible
  of displaying them.
- traprain-client: used by applications to access the routing and journey
  information exposed by the navigation service.
  It also provides API to control traprain's mock service.
- traprain-common: containing code share by the service and client libraries.
- traprain-guidance: used by the UI responsible of displaying turn-by-turn
  notifications to receive those notifications from the navigation system.

Traprain also provides tools and services which can be used by applications to
test their code in an emulator:
- traprain-mock-service: service emulating a navigation system and be used to
  publish routes and journey information.
- traprain-guidance-ui: service displaying turn-by-turn notifications using
  standard desktop notification bubbles.
- traprain-send-turn-by-turn: command line tool to send turn-by-turn notifications.
- traprain-update-progress: command line tool to update journey progress
  information.

The routes are shared between the navigation system and applications using D-Bus,
see dbus/*.xml for the definition of the API.

Design
======

See the Geolocation and navigation design for Apertis:

https://designs.apertis.org/latest/geolocation-and-navigation.html

Licensing
=========

Traprain is licensed under the MPLv2; see COPYING for more details.

Bugs
====

Bug reports and (git formatted) patches should be submitted to the Phabricator
instance for Apertis:

http://phabricator.apertis.org/

Contact
=======

See AUTHORS.