Android README example

README.md

Android Example Application

This is an example Android Application README to show briefly the sections your app README should contain.

Installation

Clone this repository and import into Android Studio

git clone git@github.com:wolox/<reponame>.git

Configuration

Keystores:

Create app/keystore.gradle with the following info:

ext.key_alias='...'
ext.key_password='...'
ext.store_password='...'

And place both keystores under app/keystores/ directory:

• playstore.keystore
• stage.keystore

Build variants

Use the Android Studio Build Variants button to choose between production and staging flavors combined with debug and release build types

Generating signed APK

From Android Studio:

1. Build menu
2. Generate Signed APK...
3. Fill in the keystore information (you only need to do this once manually and then let Android Studio remember it)

Maintainers

This project is mantained by:

• Federico Ramundo

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -m 'Add some feature')
4. Run the linter (ruby lint.rb').
5. Push your branch (git push origin my-new-feature)
6. Create a new Pull Request