README
======

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


            .---.
           /   6_6
           \_  (__\
           //   \\
          ((     ))
    =======""===""===============
             |||
             |||
             '|'


How to use Trackbook
---------------------
tbd

Which Permissions does Trackbook need?
---------------------------------------
### Permission "INTERNET"
Trackbook needs to download map data from Open Street Map servers and therefore needs access to the internet.

### Permission "ACCESS_NETWORK_STATE"
tbd

### Permission "ACCESS_WIFI_STATE"
tbd
            
### Permission "ACCESS_COARSE_LOCATION"
tbd

### Permission "ACCESS_FINE_LOCATION"
tbd

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