From 089e7c34fe52145f4834c9972100a2300d6ab298 Mon Sep 17 00:00:00 2001
From: Akhil Narang <me@akhilnarang.dev>
Date: Thu, 21 Oct 2021 18:35:21 +0530
Subject: [PATCH] gms: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..c2991f96
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# vendor_gms
+
+## Basic usage
+
+- If you just wanna use this repository, then you just need to include `products/gms.mk`
+- This is as simple as: `$(call inherit-product-if-exists, vendor/gms/products/gms.mk)`
+
+## Advanced usage
+
+### Initial setup
+- Install `xmlstarlet`
+  - `sudo apt install xmlstarlet`, `sudo pacman -S xmlstarlet`, etc. depending on your distribution.
+- Install `apktool`, make sure its available in PATH
+  - https://ibotpeaches.github.io/Apktool/install/
+  - Run `apktool if framework-res.apk` to install framework for apktool this is necessary for proper extracting
+    (generally found in /system/framework/)
+
+### Extracting / updating extracted overlays
+
+Basically the same as regular extract-files
+
+```sh
+./extract-files.sh /path/to/a/dump
+```
+
+### Removing certain overlays
+
+- If certain overlays are not required, you can simply add them to `exclude-tag.txt`, those will be removed from the extracted overlays.
+
+### Miscellaneous information
+
+- The main changes here are the addition of `apktool` and `xmlstarlet`, to allow us to extract the necessary overlays from some RROs.
+- Since the process does take a while, to speed it up, all extraction is done in the background. This might not be suitable for weaker systems if there is a very high number of overlays to be extracted.