Skip to content

Commit

Permalink
Update README, proguard, and bump version to 2.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmedre committed Mar 9, 2015
1 parent 5bdc8b5 commit 8b63422
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 77 deletions.
59 changes: 19 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,20 @@ contributors:

* [Hussein Maher](http://twitter.com/husseinmaher)
* [Ahmed Farra](http://github.com/afarra)
* [Shuhrat Dehkanov](http://github.com/ozbek)
* [Wael Nafee](http://twitter.com/wnafee)
* [Ahmed Fouad](http://twitter.com/fo2ad)
* [Mahmoud Hossam](http://github.com/mahmoudhossam)

graphics by [Somaia Gabr](http://twitter.com/somaiagabr).

Arabic support for non-Arabic phones by [Rehab Mohamed](http://twitter.com/hams_rrr), based on Arabic Reshaper project by [Ahmed Essam](http://twitter.com/Neo_4583).

Code Style
------------------------
- tab size: 2
- indent : 2
- continuous indent: 4

you can set these under code style and code style java in android studio or
intellij.
you can set these under code style and code style java in android studio or intellij.


Setup
Expand All @@ -37,8 +35,7 @@ Setup
2. make sure `$ANDROID_HOME` is set to the correct place.
3. build from the command line by running `./gradlew assembleDebug`
4. if you want an ide, download the latest version of [android studio](http://tools.android.com/download/studio/canary) (latest as of this writing is version 0.8.14)
5. run android studio, choose import project, then choose build.gradle from
the main quran source code directory.
5. run android studio, choose import project, then choose build.gradle from the main quran source code directory.

and that's it!

Expand All @@ -62,36 +59,20 @@ App localization

Terms of use
------------
you are free to use parts of the Quran Android code in your application
with some conditions:
you are free to use parts of the Quran Android code in your application with some conditions:

* your app must be respectful of the book of Allah. adding advertisements
above and below each page of Quran is unacceptable, for example (yes,
someone actually did that).
* your app must be respectful of the book of Allah. adding advertisements above and below each page of Quran is unacceptable, for example (yes, someone actually did that).

* your app must provide some significant value over our app - otherwise,
why not just contribute a patch instead?
* your app must provide some significant value over our app - otherwise, why not just contribute a patch instead?

* your app cannot make money from ads or from sales. there are many reasons
for this:
* your app cannot make money from ads or from sales. there are many reasons for this:
- we made this app for the benefit of people and not to make a profit
- the app costs us money (for serving the pages, translations, etc), not to
mention the time to develop it and to support it.
- not all of the data that we use is okay to be sold. the images, along with
some of the translations are on a license that allows their use and distribution
for free for non-profit uses, but does not allow users to make money from them.

* if you write an application using any of the Quran data (the images, the
translations, etc), you must provide a link to the respective data source
page ([tanzil.net](http://tanzil.net) for the translations and the
[quran images project](http://github.com/quran/quran.com-images) for the images)
both within your application (in an about page) and in your application
description in the market or app store.

* if you use part of (or all of) the quran android code or graphics, you
must provide a link back to the [quran android
project](http://github.com/ahmedre/quran_android) in your application
description and your application itself in an about section.
- the app costs us money (for serving the pages, translations, etc), not to mention the time to develop it and to support it.
- not all of the data that we use is okay to be sold. the images, along with some of the translations are on a license that allows their use and distribution for free for non-profit uses, but does not allow users to make money from them.

* if you write an application using any of the Quran data (the images, the translations, etc), you must provide a link to the respective data source page ([tanzil.net](http://tanzil.net) for the translations and the [quran images project](http://github.com/quran/quran.com-images) for the images) both within your application (in an about page) and in your application description in the market or app store.

* if you use part of (or all of) the quran android code or graphics, you must provide a link back to the [quran android project](http://github.com/ahmedre/quran_android) in your application description and your application itself in an about section.

Open Source Projects Used
-------------------------
Expand All @@ -101,14 +82,12 @@ Open Source Projects Used

Changelog
---------
**development**
- compile targeting sdk 21
- replace ActionBarSherlock with support-appcompat-v7
- improve share and copy ayah texts
- toggle sura prefix using a boolean flag
- fix gapless repeat releated bugs #426
- fix translation highlighting color in night mode #423
- translation updates for Uzbek
**version 2.6.0 (released 3/8/2015)**
- material design!
- experimental audio manager with download all functionality.
- change the translator from the translation popup.
- tons of bugfixes.
- now only supports sdk 14+ (ice cream sandwich and above)

**version 2.5.8 (released 7/5/2014)**
- fixing tablet bugs causing the page not to show up
Expand Down
21 changes: 0 additions & 21 deletions TODO.md

This file was deleted.

6 changes: 3 additions & 3 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ android {
defaultConfig {
minSdkVersion 14
targetSdkVersion 21
versionCode 259
versionName "2.5.9"
versionCode 2600
versionName "2.6.0"
}

signingConfigs {
Expand All @@ -33,7 +33,7 @@ android {

release {
minifyEnabled true
proguardFile 'proguard.cfg'
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard.cfg'
signingConfig signingConfigs.release
}
}
Expand Down
14 changes: 1 addition & 13 deletions app/proguard.cfg
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
-ignorewarnings
-dontoptimize
-dontobfuscate
-dontskipnonpubliclibraryclasses

-ignorewarnings

-renamesourcefileattribute SourceFile

-keepattributes SourceFile,LineNumberTable,*Annotation*

-printmapping map.txt
-printseeds seed.txt

-keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); }
-repackageclasses 'android.support.v7'

-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
Expand All @@ -26,5 +15,4 @@
public <init>(android.content.Context, android.util.AttributeSet, int);
public void set*(...);
}
-keepclassmembers class * extends android.app.Activity { public void *(android.view.View); }
-keepclassmembers class android.support.v4.app.Fragment { *** getActivity(); public *** onCreate(); public *** onCreateOptionsMenu(...); }

0 comments on commit 8b63422

Please sign in to comment.