From 51656c7b29619a47f55ec6ece3a86233c1bf450a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Allan=20Nordh=C3=B8y?= Date: Tue, 1 Nov 2022 05:55:32 +0000 Subject: README reworked and weblate added (#1209) --- README.md | 110 +++++++++++++++++++++----------------------------------------- 1 file changed, 37 insertions(+), 73 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a7642f746..af7d45703 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,59 @@ -[![Build Status](https://img.shields.io/circleci/project/github/navit-gps/navit/trunk.svg)](https://circleci.com/gh/navit-gps/navit) -[![CodeFactor](https://www.codefactor.io/repository/github/navit-gps/navit/badge)](https://www.codefactor.io/repository/github/navit-gps/navit) +# Navit [![Build Status](https://img.shields.io/circleci/project/github/navit-gps/navit/trunk.svg)](https://circleci.com/gh/navit-gps/navit) [![CodeFactor](https://www.codefactor.io/repository/github/navit-gps/navit/badge)](https://www.codefactor.io/repository/github/navit-gps/navit) [![Translation](https://hosted.weblate.org/widgets/navit/-/svg-badge.svg)](https://hosted.weblate.org/engage/navit/) +_A copylefted libre software car-navigation system with its own routing engine_. -Navit on Android tablet: - -![navit on android](https://raw.githubusercontent.com/navit-gps/navit/trunk/contrib/images/androidtablet.png) - -Navit on Linux based Carputer: - -![navit-nuc-osd](https://github.com/pgrandin/navit-nuc-layout/raw/master/screenshot.png) - +On an Android tablet \ +![navit on android](https://raw.githubusercontent.com/navit-gps/navit/trunk/contrib/images/androidtablet.png) \ +On a Linux-based carputer \ +![navit-nuc-osd](https://user-images.githubusercontent.com/13802408/198998955-4293553f-0de1-4f72-bfe7-0e72b6207a68.png) \ [Get it on F-Droid](https://f-droid.org/packages/org.navitproject.navit/) [Get it on Google Play](https://play.google.com/store/apps/details?id=org.navitproject.navit) - -Navit -===== - -Navit is a open source (GPL) car navigation system with routing engine. - -It's modular design is capable of using vector maps of various formats -for routing and rendering of the displayed map. It's even possible to -use multiple maps at a time. - -The GTK+ or SDL user interfaces are designed to work well with touch -screen displays. Points of Interest of various formats are displayed -on the map. - -The current vehicle position is either read from gpsd or directly from -NMEA GPS sensors. - -The routing engine not only calculates an optimal route to your -destination, but also generates directions and even speaks to you. - -Navit currently speaks over 70 languages! - -You can help translating via our web based translation page: - http://translations.launchpad.net/navit/trunk/+pots/navit - - -For help or more information, please refer to the wiki: - http://wiki.navit-project.org - -If you don't know where to start, we recommend you to read the -Interactive Help : http://wiki.navit-project.org/index.php/Interactive_help + height="130">](https://play.google.com/store/apps/details?id=org.navitproject.navit) \ +Modular design with routing and rendering of one or more vector maps in various formats. \ +GTK and SDL user-interfaces with touch-screen displays. \ +Current vehicle position from gpsd or directly from NMEA (GPS) sensors. \ +Optimal routes and directions spoken in 70+ languages. \ +Points of interest (POIs) in many formats. +Help and more info available on [the wiki](https://wiki.navit-project.org/index.php/Main_Page). \ +The [Reporting Bugs](http://wiki.navit-project.org/index.php/Reporting_Bugs) document helps you file issues. Maps ==== -The best navigation system is useless without maps. Those three maps -are known to work: - -- OpenStreetMap: display, routing, but street name search isn't complete - (see http://wiki.navit-project.org/index.php/OpenStreetMap) - -- Grosser Reiseplaner and compliant maps: full support - (see http://wiki.navit-project.org/index.php/Marco_Polo_Grosser_Reiseplaner) - -- Garmin maps: display, routing, search is being worked on - (see http://wiki.navit-project.org/index.php/Garmin_maps) - +[OpenStreetMap](https://wiki.navit-project.org/index.php/OpenStreetMap) — display, routing, incomplete street-name search. \ +[Grosser Reiseplaner](https://wiki.navit-project.org/index.php/Marco_Polo_Grosser_Reiseplaner) and compliant maps — full support. \ +[Garmin maps](https://wiki.navit-project.org/index.php/Garmin_maps) —display, routing, search is being worked on. GPS Support =========== -Navit reads the current vehicle position: -- directly from a file or port -- from gpsd (local or remote) -- from the location service of several mobile platforms -- from udp server (friends tracking) (experimental) +Current vehicle position from \ +— a file or port. \ +— gpsd (local or remote). \ +— the location service of several mobile platforms. \ +— a UDP server (friends tracking) (experimental). +Translation +=========== +The [Hosted Weblate](https://hosted.weblate.org/projects/navit/) platform is used to manage translations, which runs [Weblate](https://weblate.org). + +Translation status + Routing algorithm ================= -Navit uses LPA* (see [Lifelong_Planning_A*](https://en.wikipedia.org/wiki/Lifelong_Planning_A*)), a derivative of the Dijkstra algorithm, for -routing. Routing starts at the destination by assigning a value to each point directly connected to the destination -point. The value represents the estimated time needed to reach the destination from that point. - -Now the point with the lowest value is chosen using the Fibonacci heap, and a value is assigned to connected points -which are unevaluated or whose current value is greater than the new one. - -The search is repeated until the origin is found. - -Once the origin is reached, all that needs to be done is to follow the points with the lowest values to the -destination. +Uses [LPA*](https://wikiless.org/wiki/Lifelong_Planning_A*) starting at the destination by assigning \ +a value to each point directly connected to the destination point. \ +It represents estimated time needed to reach the destination from that point. \ +A Fibonacci-heap search for the point with the lowest value (to find \ +a value then assigned to connected points either unevaluated or whose \ +current value is greater than the new one) is repeated until the origin is found. \ +Once reaching the origin, the lowest-value points are followed to the destination. -LPA* is slightly more complex, as it allows partial re-evaluation of the route graph as segment costs change. This is -used by the (still experimental) traffic module, which can process traffic reports and tries to find a way around -traffic problems. Refer to the Wikipedia page for a full description. +the (experimental) traffic module re-evaluates route-graph portions as segment costs change. \ +It can process traffic reports and find a way around problems. -- cgit v1.2.1