updated information about required permissions
This commit is contained in:
y20k
parent
c5a85abb3b
commit
5a9520a105
3 changed files with 23 additions and 14 deletions
|
|
@ -2,10 +2,11 @@ How to contribute to Trackbook
|
|||
==============================
|
||||
|
||||
### Report a bug or suggest a new feature
|
||||
tbd
|
||||
Bugs and new features are being discussed on the GitHub [Issue Tracker](https://github.com/y20k/trackbook/issues).
|
||||
|
||||
### Help with translations
|
||||
tbd
|
||||
Trackbook is not available in different languages (yet). I plan to get an account for Trackbook on [Weblate](https://hosted.weblate.org/). In the meantime... If you want to help out, please contact me and check out [strings.xml](https://github.com/y20k/trackbook/blob/master/app/src/main/res/values/strings.xml).
|
||||
|
||||
### Submit your own solutions
|
||||
tbd
|
||||
Help is very welcome. Be it in the form of code, or artwork, or enhancements to the website, or tutorial videos, or whatever.
|
||||
**But please** suggest new features or enhancements in advance on the [Issue Tracker](https://github.com/y20k/trackbook/issues) before implementing them.
|
||||
|
|
|
|||
26
README.md
26
README.md
|
|
@ -6,13 +6,13 @@ Trackbook - Movement recorder for Android
|
|||
|
||||
**Version 0.1.x ("The Great Gig in the Sky")**
|
||||
|
||||
Trackbook is a bare bones app for recording your movements. Trackbook is great for hiking, vacation or workout. Once started it displays your movements on a map. You can save your recorded tracks and share them with friends.
|
||||
Trackbook is a bare bones app for recording your movements. Trackbook is great for hiking, vacation or workout. Once started it displays your movements on a map.
|
||||
|
||||
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. osmdroid is also free software. It is 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/transistor/blob/master/CONTRIBUTE.md) first.
|
||||
|
||||
Install Trackbook
|
||||
------------------
|
||||
Do not install Trackbook. Trackbook does not do anythimg useful right now. See the Install Canary below? Wait until it flies.
|
||||
Do not install Trackbook. Trackbook is not finished yet. See the Install Canary below? Wait until it flies.
|
||||
|
||||
.---.
|
||||
/ 6_6
|
||||
|
|
@ -32,11 +32,19 @@ Developement screenshot(s)
|
|||
[<img src="https://cloud.githubusercontent.com/assets/9103935/18307131/4caa247a-74ef-11e6-8059-41abfe11f71c.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18307131/4caa247a-74ef-11e6-8059-41abfe11f71c.png)
|
||||
[<img src="https://cloud.githubusercontent.com/assets/9103935/18307130/4ca9f270-74ef-11e6-96e7-d918e807e9a2.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18307130/4ca9f270-74ef-11e6-96e7-d918e807e9a2.png)
|
||||
|
||||
|
||||
|
||||
How to use Trackbook
|
||||
---------------------
|
||||
tbd
|
||||
--------------------
|
||||
### Start recording movements
|
||||
Press the big blue button to start recording your movements. Trackbook will continuously drop markers onto the map.
|
||||
|
||||
### Stop recording movements
|
||||
To stop your recording press the big blue button again or use the stop button in the Trackbook's notification. You can look at the recorded movements on the map afterwards.
|
||||
|
||||
### Distance and duration
|
||||
Peek into Trackbook's notification to see the distance and duration of your current recording.
|
||||
|
||||
### Clear the map
|
||||
You can clear the map by either long-pressing the big blue button or dismissing the notification.
|
||||
|
||||
Which Permissions does Trackbook need?
|
||||
---------------------------------------
|
||||
|
|
@ -44,10 +52,10 @@ Which Permissions does Trackbook need?
|
|||
Trackbook needs to download map data from Open Street Map servers and therefore needs access to the internet.
|
||||
|
||||
### Permission "ACCESS_NETWORK_STATE" and "ACCESS_WIFI_STATE"
|
||||
tbd
|
||||
|
||||
Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid/) to draw its main map. osmdroid needs to know the current state of your device’s connectivity - see [Prerequisites](https://github.com/osmdroid/osmdroid/wiki/Prerequisites). I am not sure why though. On the other hand: These permissions are not harmful in any way.
|
||||
|
||||
### Permission "ACCESS_COARSE_LOCATION" and "ACCESS_FINE_LOCATION"
|
||||
tbd
|
||||
Trackbook needs accurate GPS location data to be able to record your movements. If the GPS data is not available or not accurate enough Trackbook uses location data from cell tower and WiFi triangulation.
|
||||
|
||||
### Permission "WRITE_EXTERNAL_STORAGE"
|
||||
Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid), which caches map tiles on Android's external storage. You can find the map cache in the `osmdroid` folder on the top level of the user-facing file system.
|
||||
|
|
|
|||
|
|
@ -58,9 +58,9 @@
|
|||
<string name="infosheet_about_h3_internet">Permission INTERNET</string>
|
||||
<string name="infosheet_about_p_internet">Trackbook needs to download map data from Open Street Map servers and therefore needs access to the internet.</string>
|
||||
<string name="infosheet_about_h3_network">Permission ACCESS_WIFI_STATE and ACCESS_NETWORK_STATE</string>
|
||||
<string name="infosheet_about_p_network">tbd</string>
|
||||
<string name="infosheet_about_p_network">Trackbook uses to draw its main map. osmdroid needs to know the current state of your device’s connectivity. I am not sure why though. On the other hand: These permissions are not harmful in any way.</string>
|
||||
<string name="infosheet_about_h3_location">Permission ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION</string>
|
||||
<string name="infosheet_about_p_location">tbd</string>
|
||||
<string name="infosheet_about_p_location">Trackbook needs accurate GPS location data to be able to record your movements. If the GPS data is not available or not accurate enough Trackbook uses location data from cell tower and WiFi triangulation.</string>
|
||||
<string name="infosheet_about_h3_external">Permission WRITE_EXTERNAL_STORAGE</string>
|
||||
<string name="infosheet_about_p_external">Trackbook uses osmdroid, which caches map tiles on Android\'s external storage. You can find the map cache in the osmdroid folder on the top level of the user-facing file system.</string>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue