From 41d5544bc847e1090b4ffc8aba27789b7cf14503 Mon Sep 17 00:00:00 2001 From: kitsunyan Date: Mon, 22 Jun 2020 00:44:25 +0300 Subject: [PATCH] Update readme --- README.md | 35 ++++++++++++++++++++++++++--- metadata/en-US/full_description.txt | 11 ++++++++- 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8495dfc..abdfdee 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,24 @@ Yet another F-Droid client. +[![Release](https://img.shields.io/github/v/release/kitsunyan/foxy-droid)](https://github.com/kitsunyan/foxy-droid/releases) +[![F-Droid](https://img.shields.io/f-droid/v/nya.kitsunyan.foxydroid)](https://f-droid.org/packages/nya.kitsunyan.foxydroid/) + ## Description -Unofficial F-Droid client that resembles classic F-Droid client. +Unofficial F-Droid client that resembles the classic F-Droid client. -## Screenshots +The client supports all basic F-Droid features, such as repository management and package installation. It doesn't +support privileged extension, root installation, or local repositories. + +### Features + +* Classic F-Droid style, without cards or inappropriate animations +* Fast repositories synchronization under good network conditions +* Built upon standard Android components and a minimal set of dependencies +* Made with attention to details, both in program logic and design + +### Screenshots

@@ -17,6 +30,22 @@ Unofficial F-Droid client that resembles classic F-Droid client.

+## Building and Installing + +Android SDK path should be specified either using `ANDROID_HOME` environment variable or using `sdk.dir` property in +`local.properties`. + +Signing can be done automatically using `keystore.properties` as follows: + +```properties +store.file=/path/to/keystore +store.password=key-store-password +key.alias=key-alias +key.password=key-password +``` + +Run `./gradlew assembleRelease` to build the package. The package can be installed using Android package manager. + ## License -Licensed under the terms of GNU GPL version 3 or later. +Foxy Droid is available under the terms of GNU General Public License v3 or later. Copyright (C) 2020 kitsunyan. diff --git a/metadata/en-US/full_description.txt b/metadata/en-US/full_description.txt index d5cff96..56f3593 100644 --- a/metadata/en-US/full_description.txt +++ b/metadata/en-US/full_description.txt @@ -1 +1,10 @@ -Unofficial F-Droid client that resembles classic F-Droid client. +Unofficial F-Droid client that resembles the classic F-Droid client. + +The client supports all basic F-Droid features, such as repository management and package installation. It doesn't support privileged extension, root installation, or local repositories. + +Features: + +* Classic F-Droid style, without cards or inappropriate animations +* Fast repositories synchronization under good network conditions +* Built upon standard Android components and a minimal set of dependencies +* Made with attention to details, both in program logic and design