minor formatting changes

This commit is contained in:
y20k 2020-01-02 18:15:32 +01:00
parent 99265afe58
commit 9b43afdf52
No known key found for this signature in database
GPG key ID: 824D4259F41FAFF6

View file

@ -1,8 +1,8 @@
README
======
Trackbook - Movement Recorder for Android
-----------------------------------------
#Trackbook - Movement Recorder for Android
<img src="https://raw.githubusercontent.com/y20k/trackbook/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" width="192" />
**Version 2.0.x ("Echoes")**
@ -12,16 +12,15 @@ Trackbook is a bare bones app for recording your movements. Trackbook is great f
Trackbook is free software. It is published under the [MIT open source license](https://opensource.org/licenses/MIT). Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid) to display the map, which is also free software published under the [Apache License](https://github.com/osmdroid/osmdroid/blob/master/LICENSE). Want to help? Please check out the notes in [CONTRIBUTE.md](https://github.com/y20k/trackbook/blob/master/CONTRIBUTE.md) first.
Install Trackbook
-----------------
##Install Trackbook
You can install it via Google Play and F-Droid - or you can go and grab the latest APK on [GitHub](https://github.com/y20k/trackbook/releases).
[<img src="https://play.google.com/intl/de_de/badges/images/generic/en_badge_web_generic.png" width="192">](https://play.google.com/store/apps/details?id=org.y20k.trackbook)
[<img src="https://cloud.githubusercontent.com/assets/9103935/14702535/45f6326a-07ab-11e6-9256-469c1dd51c22.png" width="192">](https://f-droid.org/repository/browse/?fdid=org.y20k.trackbook)
How to use Trackbook
--------------------
##How to use Trackbook
###Start recording movements
Press the big blue button to start recording your movements. Trackbook will continuously drop markers onto the map.
@ -43,14 +42,14 @@ Saved recordings can be exported as GPX ([GPS Exchange Format](https://en.wikipe
###How does Trackbook measure distance?
Trackbook calculates the distance between markers and adds them up.
A word on privacy
-----------------
##A word on privacy
Trackbook begins to store location data on device as soon a user presses the record button. Those recordings are stored in the directory `/Android/data/org.y20k.trackbook/files/tracks`. They never leave the device. There is no web-service backing Trackbook.
Trackook does not use Google Play Services to get its location data. It will however try to use data from the [NETWORK_PROVIDER](https://developer.android.com/reference/android/location/LocationManager#NETWORK_PROVIDER) on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over whatsoever. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to `Device Only`.
Trackbook does not use Google Play Services to get its location data. It will however try to use data from the [NETWORK_PROVIDER](https://developer.android.com/reference/android/location/LocationManager#NETWORK_PROVIDER) on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over whatsoever. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to `Device Only`.
##Which permissions does Trackbook need?
Which permissions does Trackbook need?
--------------------------------------
###Permission "INTERNET"
Trackbook needs to download map data from OpenStreetMap servers and therefore needs access to the internet.
@ -63,8 +62,7 @@ Trackbook needs accurate GPS location data to be able to record your movements.
###Permission "VIBRATE"
Tapping and holding some controls will toggle a tiny vibration (force feedback).
Screenshots (v1.1)
------------------
##Screenshots (v1.1)
[<img src="https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png" width="240">](https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png)
[<img src="https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p2.png" width="240">](https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p2.png)