Merge pull request #172 from MrWooltrest/improve_readme

Improved README.md
This commit is contained in:
LooKeR 2022-02-12 19:12:00 +05:30 committed by GitHub
commit f3609fffb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 23 deletions

View File

@ -4,51 +4,65 @@
# Droid-ify
A quick material F-Droid client.
### A quick material F-Droid client.
[![Github repo stars](https://img.shields.io/github/stars/Iamlooker/Droid-ify?style=flat)](https://github.com/Iamlooker/Droid-ify/stargazers)
[![Github License](https://img.shields.io/github/license/Iamlooker/Droid-ify)](https://github.com/Iamlooker/Droid-ify/blob/master/COPYING)
[![Github All Releases](https://img.shields.io/github/downloads/Iamlooker/Droid-ify/total.svg)](https://github.com/Iamlooker/Droid-ify/releases/)
[![Github release](https://img.shields.io/github/v/release/Iamlooker/Droid-ify?display_name=tag)](https://github.com/Iamlooker/Droid-ify/releases/latest)
[![Github watchers](https://img.shields.io/github/watchers/Iamlooker/Droid-ify?label=Watch)](https://github.com/Iamlooker/Droid-ify/watchers)
[![Github forks](https://img.shields.io/github/forks/Iamlooker/Droid-ify?label=Fork)](https://github.com/Iamlooker/Droid-ify/network/members)
[![Small translation badge](https://hosted.weblate.org/widgets/droidify/-/localization/svg-badge.svg)](https://hosted.weblate.org/engage/droidify/?utm_source=widget)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
alt="Get it on IzzyDroid"
width="48%">](https://android.izzysoft.de/repo/apk/com.looker.droidify)
width="48%" align="center">](https://android.izzysoft.de/repo/apk/com.looker.droidify)
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
width="48%">](https://f-droid.org/packages/com.looker.droidify)
width="48%" align="center">](https://f-droid.org/packages/com.looker.droidify)
[<img src="https://github.com/WeblateOrg/weblate/blob/main/weblate/static/weblate.svg"
alt="Weblate"
width="40%">](https://hosted.weblate.org/projects/droidify/localization/)
width="40%" align="center">](https://hosted.weblate.org/projects/droidify/localization/)
&nbsp;&nbsp;
[<img src="https://upload.wikimedia.org/wikipedia/commons/8/82/Telegram_logo.svg"
alt="Join Telegram Channel"
width="30%">](https://t.me/droid_ify)
width="25%" align="center">](https://t.me/droid_ify)
[<img src = "https://hosted.weblate.org/widgets/droidify/-/open-graph.png"
alt= "Translation State"
width="60%">](https://hosted.weblate.org/projects/droidify/localization/)
width="60%" align="center">](https://hosted.weblate.org/projects/droidify/localization/)
<div align="left">
## :book: Features
* Material F-Droid style
* No cards or inappropriate animations
* Fast repository syncing
* Standard Android components and minimal dependencies
* :art: Material F-Droid style
* :dart: No cards or inappropriate animations
* :airplane: Fast repository syncing
* :wrench: Standard Android components and minimal dependencies
### :camera: Screenshots
## :framed_picture: Screenshots
<img src="metadata/en-US/images/phoneScreenshots/home-light.png" width="48%" /><img src="metadata/en-US/images/phoneScreenshots/app-light.png" width="48%" /><img src="metadata/en-US/images/phoneScreenshots/home-dark.png" width="48%" /><img src="metadata/en-US/images/phoneScreenshots/app-dark.png" width="48%" /><img src="metadata/en-US/images/phoneScreenshots/home-amoled.png" width="48%" /><img src="metadata/en-US/images/phoneScreenshots/app-amoled.png" width="48%" />
### :sun_with_face: Light theme
## :hammer: Building and Installing
| <img src="metadata/en-US/images/phoneScreenshots/home-light.png" width="500" align="center"/> | <img src="metadata/en-US/images/phoneScreenshots/app-light.png" width="500" align="center"/>
|:---:|:---:|
### :last_quarter_moon_with_face: Dark theme
| <img src="metadata/en-US/images/phoneScreenshots/home-dark.png" width="500" align="center"/> | <img src="metadata/en-US/images/phoneScreenshots/app-dark.png" width="500" align="center"/>
|:---:|:---:|
### :waxing_crescent_moon: Amoled theme
| <img src="metadata/en-US/images/phoneScreenshots/home-amoled.png" width="500" align="center"/> | <img src="metadata/en-US/images/phoneScreenshots/app-amoled.png" width="500" align="center"/>
|:---:|:---:|
## :building_construction: Building from source
Specify your Android SDK path either using the `ANDROID_HOME` environment variable, \
or by filling out the `sdk.dir` property in `local.properties`.
Signing can be done automatically using `keystore.properties` as follows:
### :pen: Signing
Can be done automatically using `keystore.properties` as follows:
```properties
store.file=/path/to/keystore
@ -57,18 +71,20 @@ key.alias=key-alias
key.password=key-password
```
Run `./gradlew assembleRelease` to build the package, which can be installed using the Android
package manager.
### :hammer: Building
Run `./gradlew assembleRelease` to build release package or run `./gradlew assembleDebug` if you want to build debug apk.
All of these packages can be installed using the Android package manager
## 👁️‍🗨️ Translations
[Translate Droid-ify on Hosted Weblate](https://hosted.weblate.org/engage/droidify/). \
Help us translate Droid-ify on [Hosted Weblate](https://hosted.weblate.org/engage/droidify/). \
[![Translation status](https://hosted.weblate.org/widgets/droidify/-/multi-auto.svg)](https://hosted.weblate.org/engage/droidify/?utm_source=widget)
You can always add other lanuages.
### You can always add other languages.
## :scroll: License
Licensed GPLv3+. \
Licensed under GPLv3+. \
Direct Adaptation/Modification of [Foxy-Droid](https://github.com/kitsunyan/foxy-droid/) \
Copyright © 20202021 Iamlooker and contributors.
Copyright © 20202022 [Iamlooker](https://github.com/Iamlooker) and [contributors](https://github.com/Iamlooker/Droid-ify/graphs/contributors).

View File

@ -24,6 +24,7 @@ Available in:
- Simplified Chinese
- Spanish
- Turkish
- Ukrainian
A direct adaptation/modification of Foxy-Droid