ki9
/
tracman-android
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated readme

master
Keith Irwin 2017-04-26 23:54:02 -04:00
parent 72f3111437
commit 21068d57fe
No known key found for this signature in database
GPG Key ID: 378933C743E2BBC0
1 changed files with 45 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,3 +1,46 @@
# Tracman for Android
# <img align="left" src="https://tracman.org/static/img/icon/by/48.png" alt="[]" title="The Tracman Logo">Tracman for Android
###### v 0.6.0
Android app to upload a user's GPS location to the [tracman server](https://github.com/tracman-org/android).
Android app to upload a user's GPS location to the [tracman server](https://github.com/tracman-org/Server).
## Installation
Install from the [Google Play Store](https://play.google.com/store/apps/details?id=us.keithirwin.tracman) or with `adb`/Android Studio.
## Usage
In order to apply changes to settings, you need to hit the back button and return to the main menu (where it just says "General settings"). Don't hit back again, or you will be logged out. This will be fixed as [#9](https://github.com/Tracman-org/Android/issues/9) someday...
The app will switch between "realtime updates" (Every second, or whatever interval you set up in the settings) and "occasional updates", depending on if there are visitors to your map. This prevents the app from draining your battery when nobody's looking at your location anyway.
More information is available on the [help page](https://tracman.org/help#android).
## Contributing
Tracman for Android is in perpetually poor condition. I just don't know enough about android/java to create a top-quality app. I think this project would benefit greatly from being torn down and rebuilt from scratch. If you know anything about Android, you probably know more than me. Feel free to check out the [issues marked help wanted](https://github.com/Tracman-org/Android/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) (or [any issues](https://github.com/Tracman-org/Android/issues), really) or [contact me](https://keithirwin.us/contact) about getting involved.
## Changelog
#### v0.6.0
* [#1](https://github.com/Tracman-org/Android/issues/1) Deals with lost connections
* [#6](https://github.com/Tracman-org/Android/issues/6) Loads on boot
* [#7](https://github.com/Tracman-org/Android/issues/7) Added email/password login
* [#8](https://github.com/Tracman-org/Android/issues/8) Doesn't log back in after logging out
#### v0.5.0
* Fixed compatibility issues with TLS
## License
###### see [LICENSE.md](https://github.com/Tracman-org/Android/blob/master/LICENSE.md)
Tracman: GPS tracking app for android
Copyright © 2017 [Keith Irwin](https://keithirwin.us/)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/)>.