From 7de75101fb4973a00603a354b52826328a3fafe4 Mon Sep 17 00:00:00 2001
From: Matthieu Gautier <mgautier@kymeria.fr>
Date: Tue, 20 Dec 2022 14:43:29 +0100
Subject: [PATCH] Adapt README.md and change `build.sh` into `install_deps.sh`

---
 README.md                   | 35 +++++++++++++++++++++++++++++++++--
 build.sh => install_deps.sh | 10 ----------
 2 files changed, 33 insertions(+), 12 deletions(-)
 rename build.sh => install_deps.sh (85%)

diff --git a/README.md b/README.md
index 4f51792..93d6add 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,36 @@
-# Libkiwix binding for Java/Kotlin
-
 [![Maven Central](https://img.shields.io/maven-central/v/org.kiwix.kiwixlib/kiwixlib)](https://search.maven.org/artifact/org.kiwix.kiwixlib/kiwixlib)
 [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/java-libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/java-libkiwix)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+# Java Libkiwix binding for Java/Kotlin
+
+Android Library for accessing libkiwix and libzim in android with JAVA wrapper.
+
+# Steps to build
+
+## Clone java-libkiwix
+
+```bash
+git clone https://github.com/kiwix/java-libkiwix.git
+cd java-libkiwix
+```
+
+## Install dependencies
+
+```bash
+./install_deps.sh
+```
+
+## Compile
+
+
+```bash
+./gradlew generateHeaderFilesFromJavaWrapper
+./gradlew build
+```
+
+AAR file will be generated in directory `lib/build/outputs/aar`
+
+
+
+
diff --git a/build.sh b/install_deps.sh
similarity index 85%
rename from build.sh
rename to install_deps.sh
index 5f83a82..92cf023 100755
--- a/build.sh
+++ b/install_deps.sh
@@ -14,8 +14,6 @@ printf "${Green}Downloading libzim ${NC}\n"
 ./gradlew downloadLibzimSoAndHeaderFiles unzipLibzim
 printf  "\n${Green}Done! ${NC}\n"
 
-hash -r
-
 printf "${Green}Coping libzim header and so files ${NC}\n"
 ./gradlew checkCurrentLibzimDate copyLibzimHeaderFiles copyLibzimAndroidArm copyLibzimAndroidArm64 copyLibzimAndroidx86 copyLibzimAndroidx86_64 copyLibzimLinux_x86_64 renameLibzimSoFile
 printf  "\n${Green}Down! ${NC}\n"
@@ -24,14 +22,6 @@ printf "${Green}Downloading libkiwix ${NC}\n"
 ./gradlew downloadLibkiwixSoAndHeaderFiles unzipLibkiwix
 printf  "\n${Green}Done! ${NC}\n"
 
-hash -r
-
 printf "${Green}Coping libkiwix header and so files ${NC}\n"
 ./gradlew checkCurrentLibkiwixDate copyLibkiwixHeaderFiles copyLibkiwixAndroidArm copyLibkiwixAndroidArm64 copyLibkiwixAndroidx86 copyLibkiwixAndroidx86_64 copyLibkiwixLinux_x86_64 renameLibkiwixSoFile
 printf  "\n${Green}Done! ${NC}\n"
-
-printf "${Green}Generating header files from java wrapper files ${NC}\n"
-./gradlew generateHeaderFilesFromJavaWrapper
-printf  "\n${Green}Done! ${NC}\n"
-
-hash -r