docs: Footnotes, typos, clarification

This commit is contained in:
Piotr Dec 2024-09-03 22:03:50 +02:00
parent 6a0c27e2c0
commit 242c814a84
Signed by: stawros
GPG key ID: F89F27AD8F881A91

View file

@ -2,7 +2,8 @@
## Purpose of this project
Garmin created fantastic Head-up Display, but they had it discontinued in 2015 ([src](https://support.garmin.com/pl-PL/?faq=gJy4U1QaPL2gBs3AqQ7Lm5)). Fortunately, whole protocol had beed [reverse engineered](https://github.com/gabonator/Work-in-progress/tree/master/GarminHud). This allowed community to createte their own works.
Garmin created fantastic Head-up Display, but they had it discontinued in 2015[^1].
Fortunately, whole protocol had been reverse engineered[^2]. This allowed community to create their own works.
## Works
@ -14,31 +15,34 @@ Two weeks later I switched to Mapbox as completely standalone solution. Despite
### Stack
- Kotlin 1.9i
- Kotlin 1.9
- Mapbox SDK 11.5.1
- Navigation SDK 3.2.0
- Search SDK 2.4.0
### Future works
- optimisation
- bug fixes
- camera behaviour
- search prompt graphics
- reconnect button style
- garmin connection fixes - socket behaviour on reconnect
- maneuver processing (on long distances it refreshes every 10+ km)
- Android Auto integration
- create fork for first idea of proxying GMaps
All the plans cannot be simply specified as they depend on many factors.
Main conception is not firmly grunted so it can depend on final decisions:
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
1. Standalone application
- optimisation
- bug fixes
- camera behaviour
- search prompt graphics
- reconnect button style
- garmin connection fixes - socket behaviour on reconnect
- maneuver processing (on long distances it refreshes every 10+ km)
- Android Auto integration
- POIs
- speed cameras database
- traffic data
[^1]: This is the first footnote.
2. Proxy (one to choose from)
- Google Maps (probably)
- Yanosik
- Waze
[^bignote]: Here's one with multiple paragraphs and code.
[^1]: Source: https://support.garmin.com/pl-PL/?faq=gJy4U1QaPL2gBs3AqQ7Lm5
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
[^2]: As widely described on sites like Hackday. Most repeated repo link is https://github.com/gabonator/Work-in-progress/tree/master/GarminHud