Skip to content

Commit d91651e

Browse files
authored
Merge pull request #55 from kiwix/kelson42-patch-1
Update README.md
2 parents f48a43a + 7ac4541 commit d91651e

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
1+
Libkiwix binding for Java/Kotlin
2+
================================
3+
4+
Library for accessing [libkiwix](https://github.com/kiwix/libkiwix) and [libzim](https://github.com/openzim/libzim/) with Java or Kotlin on Android.
5+
16
[![Maven Central](https://img.shields.io/maven-central/v/org.kiwix.libkiwix/libkiwix)](https://search.maven.org/artifact/org.kiwix.libkiwix/libkiwix)
7+
[![Build Status](https://github.com/kiwix/java-libkiwix/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/kiwix/java-libkiwix/actions?query=workflow%3ACI+branch%3Amain)
28
[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/java-libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/java-libkiwix)
9+
[![Codecov](https://codecov.io/gh/kiwix/java-libkiwix/branch/main/graph/badge.svg)](https://codecov.io/gh/kiwix/java-libkiwix)
310
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
411

5-
# Java Libkiwix binding for Java/Kotlin
6-
7-
Android Library for accessing libkiwix and libzim in android with JAVA wrapper.
8-
9-
# Steps to build
10-
11-
## Clone java-libkiwix
12-
13-
```bash
14-
git clone https://github.com/kiwix/java-libkiwix.git
15-
cd java-libkiwix
16-
```
12+
# Build
1713

1814
## Install dependencies
19-
2015
```bash
2116
./install_deps.sh
2217
```
2318

2419
## Compile
25-
26-
2720
```bash
2821
./gradlew buildHeaders
2922
./gradlew build
@@ -32,5 +25,11 @@ cd java-libkiwix
3225
AAR file will be generated in directory `lib/build/outputs/aar`
3326

3427

28+
# License
29+
30+
[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
31+
[COPYING](COPYING) for more details.
32+
33+
3534

3635

0 commit comments

Comments
 (0)