voussoir/trkpt
1
0
Fork 0
Code Issues Projects Releases Packages Activity

updated README to reflect new features

Browse source
This commit is contained in:
y20k 2016-12-20 11:21:09 +01:00
parent d5b4d9b8c2
commit 3bd4f4df3b
1 changed files with 14 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -4,7 +4,7 @@ README
Trackbook - Movement Recorder for Android
-----------------------------------------
**Version 0.9.x ("The Great Gig in the Sky")**
**upcoming Version 1.0.x ("Astronomy Domine")**
Trackbook is a bare bones app for recording your movements. Trackbook is great for hiking, vacation or workout. Once started it traces your movements on a map. The map data is provided by [OpenStreetMap (OSM)](https://www.openstreetmap.org/).
@ -12,26 +12,12 @@ Trackbook is free software. It is published under the [MIT open source license](
Install Trackbook
-----------------
Version 0.9 is the first release of Trackbook. It is not completely finished yet, but you can install it. Watch the install canary... It finally flies(*). You 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).
You 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)
.--.
/ 6\_
\ ___\
________________/ \_______________
\_____ / \ _____/
\______ | | ______/
\_____ \ / ______/
\___/\ /\___/
/A A\
/ \
`"==="`
(*) before it just sat [here](https://github.com/y20k/trackbook/blob/42ce5a3e764cd84365afaf0bb58929482b9e0890/README.md)
How to use Trackbook
--------------------
### Start recording movements
@ -40,37 +26,28 @@ Press the big blue button to start recording your movements. Trackbook will cont
### 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.
### Save last recording
Stop the recording and then tap again on the big blue button. It will offer an option to "Save and Clear". Trackbook stores saved recordings as plaintext JSON files in the directory `/Android/data/org.y20k.trackbook/files/tracks`.
### How do you measure the distance?
Trackbook calculates the distance between markers and adds them up.
### Clear main map
Stop the recording and then tap again on the big blue button. Chose the option "Clear", if you just want to clear the map without saving your recording.
### Clear the map
You can clear the map by either long-pressing the big blue button or dismissing the notification.
### Statistics and Last Track
Peek into Trackbook's notification to see the distance and duration of your current recording. Switch to the Last Track to review your last recording. Pull up the statistics to see distance and duration of that recording, as well as the steps taken.
### How doe Trackbook measure distance?
Trackbook calculates the distance between set markers and adds them up.
Which Permissions does Trackbook need?
--------------------------------------
### Permission "INTERNET"
Trackbook needs to download map data from OpenStreetMap servers and therefore needs access to the internet.
### Permission "ACCESS_NETWORK_STATE" and "ACCESS_WIFI_STATE"
### Permission "ACCESS\_NETWORK\_STATE" and "ACCESS\_WIFI\_STATE"
Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid/) to draw its maps. osmdroid needs to know the current state of your device’s connectivity - see [Prerequisites](https://github.com/osmdroid/osmdroid/wiki/Prerequisites).
### Permission "ACCESS_COARSE_LOCATION" and "ACCESS_FINE_LOCATION"
### Permission "ACCESS\_COARSE\_LOCATION" and "ACCESS\_FINE\_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.
### Permission "WRITE_EXTERNAL_STORAGE"
### 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.
Developement screenshots
------------------------
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436615/9e6d973e-78f9-11e6-8d3d-21f655127579.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436615/9e6d973e-78f9-11e6-8d3d-21f655127579.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436620/a1d5b71c-78f9-11e6-8770-5b7955a7d762.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436620/a1d5b71c-78f9-11e6-8770-5b7955a7d762.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436623/a42cb416-78f9-11e6-9f34-e7b3203f1ea9.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436623/a42cb416-78f9-11e6-9f34-e7b3203f1ea9.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436627/a6822cfa-78f9-11e6-9662-0e7f245312e9.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436627/a6822cfa-78f9-11e6-9662-0e7f245312e9.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436628/a8b22692-78f9-11e6-9498-a48464285e6c.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436628/a8b22692-78f9-11e6-9498-a48464285e6c.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436629/aad5ac78-78f9-11e6-8e3d-915d46f76765.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436629/aad5ac78-78f9-11e6-8e3d-915d46f76765.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436631/ad2cf63e-78f9-11e6-9ea6-68bbfee0f7d4.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436631/ad2cf63e-78f9-11e6-9ea6-68bbfee0f7d4.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/18436633/afe55aba-78f9-11e6-9720-0554fd5b4107.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/18436633/afe55aba-78f9-11e6-9720-0554fd5b4107.png)