aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMenny Even Danan <menny@evendanan.net>2020-02-10 20:24:16 +0000
committerMenny Even Danan <menny@evendanan.net>2020-02-10 20:24:16 +0000
commitb6bb378667de5fd4853ef152f26980a427fd554e (patch)
treec7d6e33d516d389500bca545548d788ab4eb8196 /README.md
parent73b26ed85a03c74837ab94a1cd926342f63a369a (diff)
downloadAnySoftKeyboard-b6bb378667de5fd4853ef152f26980a427fd554e.tar.gz
AnySoftKeyboard-b6bb378667de5fd4853ef152f26980a427fd554e.tar.bz2
Refactoring readme and contributing docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 14 insertions, 27 deletions
diff --git a/README.md b/README.md
index e7b94d264..9da82b842 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,10 @@
-AnySoftKeyboard [![Latest release](https://img.shields.io/github/release/AnySoftKeyboard/AnySoftKeyboard.svg)](https://github.com/AnySoftKeyboard/AnySoftKeyboard/releases)
+AnySoftKeyboard&nbsp;[![Latest release](https://img.shields.io/github/release/AnySoftKeyboard/AnySoftKeyboard.svg)](https://github.com/AnySoftKeyboard/AnySoftKeyboard/releases)
====================
-`master` latest build: ![](https://github.com/AnySoftKeyboard/AnySoftKeyboard/workflows/checks/badge.svg?event=push&branch=master)<br/>
-`master` latest deploy: ![](https://github.com/AnySoftKeyboard/AnySoftKeyboard/workflows/deploy/badge.svg?event=push&branch=master)<br/>
-`master` coverage: [![codecov](https://codecov.io/gh/AnySoftKeyboard/AnySoftKeyboard/branch/master/graph/badge.svg)](https://codecov.io/gh/AnySoftKeyboard/AnySoftKeyboard)<br/>
+Support channels can be found on &nbsp;[![Gitter chat](https://badges.gitter.im/AnySoftKeyboard/gitter.png)](https://gitter.im/AnySoftKeyboard)<br/>
+<br/>
+`master` latest build&nbsp;![](https://github.com/AnySoftKeyboard/AnySoftKeyboard/workflows/checks/badge.svg?event=push&branch=master)<br/>
+`master` coverage&nbsp;[![codecov](https://codecov.io/gh/AnySoftKeyboard/AnySoftKeyboard/branch/master/graph/badge.svg)](https://codecov.io/gh/AnySoftKeyboard/AnySoftKeyboard)<br/>
<br/>
-&nbsp;&nbsp;&nbsp;&nbsp;[![Gitter chat](https://badges.gitter.im/AnySoftKeyboard/gitter.png)](https://gitter.im/AnySoftKeyboard)
-
-
Android (f/w 2.1+, API level 7+) on screen keyboard for multiple languages.
<a href="https://play.google.com/store/apps/details?id=com.menny.android.anysoftkeyboard&utm_source=global_co&utm_medium=prtnr&utm_content=Mar2515&utm_campaign=PartBadge&pcampaignid=MKT-AC-global-none-all-co-pr-py-PartBadges-Oct1515-1"><img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/apps/en-play-badge.png" height="80pt"/></a>&nbsp;&nbsp;<a href="https://f-droid.org/repository/browse/?fdid=com.menny.android.anysoftkeyboard"><img alt="Get it on F-Droid" src="https://f-droid.org/wiki/images/5/55/F-Droid-button_get-it-on_bigger.png" height="80pt"/></a>
@@ -38,30 +36,19 @@ Sign up to beta-channel [here](https://play.google.com/apps/testing/com.menny.an
* Every once in a while, a stable enough _ALPHA_ will be promoted to _BETA_. You can opt-in to this channel by visiting [this link](https://play.google.com/apps/testing/com.menny.android.anysoftkeyboard).
* Once all requirements for a release were finished, a _STABLE_ release branch (in the format of `release-branch-vX.X-rX`) will be cut. Every commit to this branch will be automatically published to Google Play Store, and will roll-out users gradually.
-# Development
-To develop this project, you'll need:
- * Java 10 - get [OpenJDK](https://jdk.java.net/archive/) or [AdoptOpenJDK](https://adoptopenjdk.net/releases.html?variant=openjdk10&jvmVariant=hotspot). If you are using [jEnv](https://www.jenv.be/) then we have a `.java-version` file already set up.
- * Make sure you have the environment variable `JAVA_OPTS='-XX:+IgnoreUnrecognizedVMOptions --add-modules java.se.ee'`. This is required to ensure the JVM is merciful with libraries that were not designed for Java9+ JVMs.
- * git
- * [Android Studio](https://developer.android.com/studio/install)
- * Android SDK API Level 28 installed. Set up `local.properties` file to point to it (that is, ensure you have `sdk.dir=/path/to/android/sdk` in it).
- * Android NDK [r14b](https://developer.android.com/ndk/downloads/older_releases.html) installed. Set up `local.properties` file to point to it (that is, ensure you have `ndk.dir=/path/to/android/ndk` in it).
-
-## Continuous Integration and Pull-Requests Verifications
-Each PR is verified by multiple tasks:
- * Code Style is verified by _Google Java Format_. You can auto-format changes by running `./gradlew googleJavaFormat`
- * Static-Analysis is done with checkstyle, lint and Error-Prone. Run `./scripts/ci/ci_check.sh` to execute all checks.
- * Unit-Tests are verified using `./gradlew testDebugUnitTest`.
-
-# Notes
-
-* Via [Bountysource](https://www.bountysource.com/teams/anysoftkeyboard/issues), users can post bountys and developers can claim them when fixing bugs. This is an external community project and not directly sponsored by the ASK developers!
-
+# Read more
+* Our fancy [web-site](http://anysoftkeyboard.github.io/)
+* [Language-Pack](addons/languages/PACKS.md) add-ons in this repo.
+* [Theme](addons/themes/PACKS.md) add-ons in this repo.
+* [Quick-Text](addons/quicktexts/PACKS.md) add-ons in this repo.
+* [Crownin](https://crowdin.com/project/anysoftkeyboard) to translate the app to your language. [![Crowdin](https://badges.crowdin.net/anysoftkeyboard/localized.svg)](https://crowdin.com/project/anysoftkeyboard)
+* Via [Bountysource](https://www.bountysource.com/teams/anysoftkeyboard/issues), users can post bounties and developers can claim them when fixing bugs. This is an external community project and not directly sponsored by the ASK developers!
+* Want to developer or contribute? Read more [here](CONTRIBUTING.md)
License
-------
- Copyright 2018 Menny Even-Danan
+ Copyright 2020 Menny Even-Danan
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.