Commit ba8787c4 authored by Stefan Haslinger's avatar Stefan Haslinger

updated readme

parent c7467c0d
......@@ -2,31 +2,47 @@
tl;dr: Activity tracker data analysis app for Android and iOS
If you want to get back all your running, cycling, ... tracking data and analyse it yourself,
this app could be interesting for you one day. Currently, we are in early alpha stage, so we thought,
let's just share some screenshots to get folks interested:
### List of activities
![List of activities](/screenshots/1.png)
### Power over heart rate diagram for the last activities
![Power over heart rate diagram for the last activities](/screenshots/2.png)
### Power duration diagram for a single activity
![Power duration diagram for a single activity](/screenshots/3.png)
### Heart rate diagram for a single activity
![Heart rate diagram for a single activity](/screenshots/4.png)
Encrateia is [GPL v3](LICENSE) licensed and will always stay open source software.
Future versions in app/play stores might not be for free, but you will always be able to get
the source code and build it yourself.
# Notes for Self-Compiling
Creating an api to test:
`flutter build apk --split-per-abi`
If you want to get back all your running, cycling, ... tracking data and analyse
it yourself, this app could be interesting for you one day. Currently, we are in
the beta stage.
There is a [marketing site for Encrateia](https://encrateia.informatom.com),
which gives all the details about downloading, compatibility, the team and
lots of screenshots.
## License
Encrateia is [GPL v3](LICENSE) licensed and will always stay open source
software. Future versions in app/play stores will not be for free, but you will
always be able to get the source code and build it yourself.
## Instructions for Self-Compiling
If you want to compile Encrateia yourself, this is the way to go:
* First you need to have [Flutter](https://flutter.dev/docs/get-started/install)
(and Dart) installed for your operating system.
* If you want to have Strava integration, i.e. downloads working, you need to get
your own app token from Strava, because it's your app then. All
the responsibilities using Strava's API are on your side then.
See Strava's
[Authorization Documentation](https://developers.strava.com/docs/authentication/)
for details and how to request access.
* You then need to create a file `secrets.dart` within `/lib/secrets/` and enter
your secret and client id:
```
final String secret = "my_token_which_is_a_long_hex_string";
final String clientId = "my_client_id_which_is_a_five_digit_integer";
```
* If you don't care about Strava integration, you'll still need that file,
just put in some dummy data for secret and client id:
```
final String secret = "a1b2c3d4e5f6";
final String clientId = "12345";
```
* I always forget how to split into apks by architecture, when compiling.
This is, how it's done: `flutter build apk --split-per-abi`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment