kiwix/kiwix-android
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-android.git synced 2025-08-03 10:46:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Isaac Hutt 2017-11-28 00:56:31 +00:00 committed by GitHub
parent 94c79b5830
commit 46727a98a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -2,10 +2,13 @@ Kiwix is an offline reader for Web content. One of its main purposes is to make
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 run the command:
```./gradlew build ``` from the root directory of the project or alternatively import the project into Android Studio and build using that.
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.
Before contributing be sure to check out https://github.com/kiwix/kiwix-android/blob/master/CONTRIBUTING.md.
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.
Kiwix Android can be built on Linux, Windows or Mac.
*********************************************************************