From 68c38cbc71c3df4428c130ddc491214e35927884 Mon Sep 17 00:00:00 2001
From: Eric Marchand <129385512+e-marchand@users.noreply.github.com>
Date: Wed, 10 May 2023 16:14:35 +0200
Subject: [PATCH] Create README.md

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0592de5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# android-QMobileDataStore
+
+
+[![Language](http://img.shields.io/badge/language-kotlin-purple.svg?style=flat)](https://developer.android.com/kotlin)
+[![Build](https://github.com/4d/android-QMobileDataStore/actions/workflows/build.yml/badge.svg)](https://github.com/4d/android-QMobileDataStore/actions/workflows/build.yml)
+
+This android package belong to [Android SDK](https://github.com/4d/android-sdk) and it contains all stuff to initialize and populate the [Room](https://developer.android.com/jetpack/androidx/releases/room) database.
+
+## Build
+
+To build you can open project with Android Studio or run
+
+```bash
+./gradlew assemble --console=rich
+```
+
+To check also your development environment you can run instead [`build.sh`](build.sh)
+
+### Requirements
+
+By installing [Android Studio](https://developer.android.com/) you could fulfill all requirements, but you could also download them separately.
+
+#### Java 11
+
+You could download it [here](https://www.oracle.com/java/technologies/downloads/)
+
+💡 Java 11 is embedded in recent Android Studio versions. For instance on macOS you could do 
+
+```bash
+export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"
+```
+
+#### Android SDK
+
+To build you should download Android SDK or use one provided by Android Studio.
+
+Then `ANDROID_HOME` environnement variable must defined the SDK path.
+
+```bash
+export ANDROID_HOME=<path to sdk>
+```
+
+Default path when using Android Studio for Android SDK on macOS is `$HOME/Library/Android/sdk` and on linux `$HOME/Android/Sdk`