diff --git a/README.md b/README.md index e9c58d1a5..12275ead1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,36 @@ +[![Get it on Google Play](https://img.shields.io/github/release-pre/tasks/tasks.svg?label=google%20play%20store)](https://play.google.com/store/apps/details?id=org.tasks&utm_source=global_co&utm_medium=prtnr&utm_content=Mar2515&utm_campaign=PartBadge&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1) +[![Get it on Amazon App Store](https://img.shields.io/github/release/tasks/tasks.svg?label=amazon%20app%20store)](https://www.amazon.com/gp/product/B00QHGTL7O/ref=mas_pm_tasks_astrid_to_do_list_clone) +[![Get it on F-Droid](https://img.shields.io/f-droid/v/org.tasks.svg)](https://f-droid.org/packages/org.tasks/) + +[![Donate with Bitcoin](https://img.shields.io/badge/bitcoin-donate-yellow.svg?logo=bitcoin)](https://en.cryptobadges.io/donate/136mW34jW3cmZKhxuTDn3tHXMRwbbaRU8s) +[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg?logo=paypal)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=alex@tasks.org) +[![Liberapay donate button](https://img.shields.io/liberapay/receives/tasks.svg?logo=liberapay)](https://liberapay.com/tasks/donate) + [![Build Status](https://travis-ci.org/tasks/tasks.svg?branch=master)](https://travis-ci.org/tasks/tasks) [![codecov](https://codecov.io/gh/tasks/tasks/branch/master/graph/badge.svg)](https://codecov.io/gh/tasks/tasks) -[![Donate with Bitcoin](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://en.cryptobadges.io/donate/136mW34jW3cmZKhxuTDn3tHXMRwbbaRU8s) -[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=alex@tasks.org) +--- + +Please visit [tasks.org](https://tasks.org) for end user documentation and support + +--- + +#### To get started with development: +1. [Fork](https://help.github.com/articles/fork-a-repo/) and [clone](https://help.github.com/articles/cloning-a-repository/) the repository + * command line users: clone with `--recurse-submodules` or run `git submodule update --init` after cloning +2. Install and launch [Android Studio](https://developer.android.com/studio/index.html) +3. Select `File > Open`, select the Tasks directory, and accept prompts to install missing SDK components -Get it on Google Play - -[![Get it on Amazon App Store](https://images-na.ssl-images-amazon.com/images/G/01/mobile-apps/devportal2/res/images/amazon-underground-app-us-black.png)](https://www.amazon.com/gp/product/B00QHGTL7O/ref=mas_pm_tasks_astrid_to_do_list_clone) +#### Set up Mapbox +1. Register at [mapbox.com](https://www.mapbox.com) +2. Add `tasks_mapbox_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file. You can create an access token or use your [default public token](https://docs.mapbox.com/help/glossary/access-token/#default-public-token) -Visit the wiki to -* [help with translations](http://tasks.org/docs/translations.html) -* [become a beta tester](http://tasks.org/docs/pre_release_testing.html) -* [get started with development](http://tasks.org/docs/develop.html) +#### Set up Google APIs +1. Register at [cloud.google.com](https://cloud.google.com) +2. [Enable](https://cloud.google.com/apis/docs/enable-disable-apis#enable_an_api) the following APIs + * [Google Tasks API](https://console.cloud.google.com/apis/library/tasks.googleapis.com) + * [Google Maps SDK](https://console.cloud.google.com/apis/library/maps-android-backend.googleapis.com) + * [Google Places API](https://console.cloud.google.com/apis/library/places-backend.googleapis.com) + * [Google Drive API](https://console.cloud.google.com/apis/library/drive.googleapis.com) +3. [Set up an API key](https://cloud.google.com/video-intelligence/docs/common/auth#set_up_an_api_key) +4. Add `tasks_google_key_debug=""` to your [`gradle.properties`](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties) file +5. Select `Build > Select Build Variant` and choose the `googleplay` variant