README
======

Trackbook - Movement Recorder for Android
-----------------------------------------

**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/).

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/transistor/blob/master/CONTRIBUTE.md) first.

Install Trackbook
-----------------
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)

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.

### 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.

### 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`.

### 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.

### Statistics and Last Track
Peek into Trackbook's notification to see the distance and duration of your current recording. Switch to the Last Track view to review your last recording. Pull up the statistics to see distance and duration of that recording, as well as the steps taken.

### How does Trackbook measure distance?
Trackbook calculates the distance between 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"
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"
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.

## Screenshots (current version)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387023/0a6eef1c-c776-11e6-8a88-a00aa2ad5979.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387023/0a6eef1c-c776-11e6-8a88-a00aa2ad5979.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387024/0a6f9eb2-c776-11e6-80fb-ca098e9303ad.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387024/0a6f9eb2-c776-11e6-80fb-ca098e9303ad.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387025/0a701f68-c776-11e6-8f9a-66fb7e6eafff.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387025/0a701f68-c776-11e6-8f9a-66fb7e6eafff.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387026/0a704614-c776-11e6-94fa-27f9cb566b91.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387026/0a704614-c776-11e6-94fa-27f9cb566b91.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387028/0a70d71e-c776-11e6-8838-934eb11dbca7.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387028/0a70d71e-c776-11e6-8838-934eb11dbca7.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387027/0a70c468-c776-11e6-9405-b91c5bc902c4.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387027/0a70c468-c776-11e6-9405-b91c5bc902c4.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387029/0a81c344-c776-11e6-866b-7e608e2e9f33.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387029/0a81c344-c776-11e6-866b-7e608e2e9f33.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387030/0a82ca96-c776-11e6-9b3c-6c83f61f2188.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387030/0a82ca96-c776-11e6-9b3c-6c83f61f2188.png)
[<img src="https://cloud.githubusercontent.com/assets/9103935/21387031/0a838274-c776-11e6-8e1c-f1bb7baf5ebe.png" width="240">](https://cloud.githubusercontent.com/assets/9103935/21387031/0a838274-c776-11e6-8e1c-f1bb7baf5ebe.png)