Add a few badges to the README.md

This commit is contained in:
Kelson 2019-08-26 14:34:54 +02:00
parent 0c4a2005e4
commit 6dc009f263

View File

@ -1,27 +1,41 @@
<img src="https://github.com/kiwix/kiwix-android/blob/master/Kiwix_icon_transparent_512x512.png" align="right" height='250' /> <img src="https://github.com/kiwix/kiwix-android/blob/master/Kiwix_icon_transparent_512x512.png" align="right" height='250' />
<a href="https://play.google.com/store/apps/details?id=org.kiwix.kiwixmobile" target='_blank' align="right"> <a href="https://play.google.com/store/apps/details?id=org.kiwix.kiwixmobile" target="_blank" align="left">
<img align="right" height="36" src="https://play.google.com/intl/en/badges/images/badge_new.png" /> <img src="https://play.google.com/intl/en/badges/images/badge_new.png" alt="Get it on Google Play" height="30" />
</a>
<a href="https://f-droid.org/fr/packages/org.kiwix.kiwixmobile/" target="_blank" align="left">
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/0d/Get_it_on_F-Droid.svg/320px-Get_it_on_F-Droid.svg.png" alt="Get it on F-Droid" height="30" />
</a> </a>
# Kiwix-Android # Kiwix-Android
Kiwix is an offline reader for Web content. One of its main purposes is to make Wikipedia available offline. This is done by reading the content of a file in the ZIM format, a highly compressed open format with additional meta-data. Kiwix is an offline reader for Web content. One of its main purposes
is to make Wikipedia available offline. This is done by reading the
content of a file in the ZIM format, a highly compressed open format
with additional meta-data.
Kiwix is written in [Kotlin](https://kotlinlang.org/) (with a few old pieces in Java). Kiwix is written in [Kotlin](https://kotlinlang.org/) (with a few old
pieces in Java).
[![Build Status](https://travis-ci.org/kiwix/kiwix-android.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-android) [![Build Status](https://travis-ci.org/kiwix/kiwix-android.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-android)
[![IRC Web](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](http://chat.kiwix.org) [![IRC Web](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](http://chat.kiwix.org)
[![codecov](https://codecov.io/gh/kiwix/kiwix-android/branch/master/graph/badge.svg)](https://codecov.io/gh/kiwix/kiwix-android) [![codecov](https://codecov.io/gh/kiwix/kiwix-android/branch/master/graph/badge.svg)](https://codecov.io/gh/kiwix/kiwix-android)
[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-android/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-android) [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-android/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-android)
--- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
## Build Instructions ## Build Instructions
Production releases of the app should be built with our companion build repository [kiwix-build](https://github.com/kiwix/kiwix-build). Production releases of the app should be built with our companion
build repository [kiwix-build](https://github.com/kiwix/kiwix-build).
To build this repository alone for development purposes you can simply import the project into Android Studio and the hard work will be done for you. If you prefer to build without Android Studio you must first set up the Android SDK and then run the command: ```./gradlew build ``` from the root directory of the project. To build this repository alone for development purposes you can simply
import the project into Android Studio and the hard work will be done
for you. If you prefer to build without Android Studio you must first
set up the Android SDK and then run the command: `./gradlew build `
from the root directory of the project.
We utilize different build variants (flavours) to build various different versions of our app. Ensure your build variant is **kiwixDebug** to build the standard app. We utilize different build variants (flavours) to build various
different versions of our app. Ensure your build variant is
`kiwixDebug` to build the standard app.
## Libraries Used ## Libraries Used
@ -38,29 +52,39 @@ We utilize different build variants (flavours) to build various different versio
## Contributing ## Contributing
Before contributing be sure to check out the [CONTRIBUTION](https://github.com/kiwix/kiwix-android/blob/master/CONTRIBUTING.md) guidelines. Before contributing be sure to check out the
[CONTRIBUTION](https://github.com/kiwix/kiwix-android/blob/master/CONTRIBUTING.md)
guidelines.
We currently have a series of automated Unit and Integration tests. These can be run locally and are also run when submitting a pull request. We currently have a series of automated Unit and Integration
tests. These can be run locally and are also run when submitting a
pull request.
## Code Style ## Code Style
For contributions please read the [CODESTYLE](docs/codestyle.md) carefully. Pull requests that do not match the style will be rejected.
For contributions please read the [CODESTYLE](docs/codestyle.md)
carefully. Pull requests that do not match the style will be rejected.
## Commit Style ## Commit Style
For writing commit messages please read the [COMMITSTYLE](docs/commitstyle.md) carefully. Kindly adhere to the guidelines. Pull requests not matching the style will be rejected. For writing commit messages please read the
[COMMITSTYLE](docs/commitstyle.md) carefully. Kindly adhere to the
guidelines. Pull requests not matching the style will be rejected.
## Communication ## Communication
Please use IRC to discuss questions regarding the project: #kiwix on irc.freenode.net Please use IRC to discuss questions regarding the project: #kiwix on
irc.freenode.net
You can use IRC web interface on [http://chat.kiwix.org/](http://chat.kiwix.org/). You can use IRC web interface on
[http://chat.kiwix.org/](http://chat.kiwix.org/).
Our other sources of communications include
Our other sources of communications include:
- Email: contact@kiwix.org - Email: contact@kiwix.org
- Mailing list: kiwix-developer@lists.sourceforge.net - Mailing list: kiwix-developer@lists.sourceforge.net
For more information, please refer to [https://wiki.kiwix.org/wiki/Communication](https://wiki.kiwix.org/wiki/Communication). For more information, please refer to
[https://wiki.kiwix.org/wiki/Communication](https://wiki.kiwix.org/wiki/Communication).
## LEGAL & DISCLAIMER ## LEGAL & DISCLAIMER