README & BoardConfig Commits

BoardConfig.mk

@@ -92,3 +92,6 @@ TW_EXCLUDE_TWRPAPP := true
 -include $(LOCAL_PATH)/BoardConfigOFOX.mk
 -include $(LOCAL_PATH)/BoardConfigSHRP.mk
 -include vendor/kud/config/recovery.mk
+
+# Internal Storage Fix
+RECOVERY_SDCARD_ON_DATA := true

README.md

@@ -1,11 +1,28 @@
-# android_device_xiaomi_mi8937
+# Recovery for Mi MSM8937 Devices
 
-For building TWRP for Xiaomi MSM8937 Devices
+**To compile:**
 
-To compile:
+```
+$ export ALLOW_MISSING_DEPENDENCIES=true
+$ . build/envsetup.sh && lunch omni_mi8937-eng && mka recoveryimage
+```
+
+After compilation find recovery.img in out/target/product/mi8937/recovery.img
+
+**Requires python2.7:** 
+
+If using pyenv:
+```
+$ pyenv install 2.7.18
+$ nano ~/.pyenv/version
+```
+~/.pyenv/version file opened up in nano, edit the version and put `2.7.18` instead. 
+
+_If not using pyenv:_ [Refer Here](https://telegra.ph/Install-Python-27-on-Linux-03-07) 
 
+If `pyenv versions` returns 2.7.18 version as default but `python -V` returns 3.x as default:
 ```
-. build/envsetup.sh && breakfast mi8937 eng && mka recoveryimage
+sudo update-alternatives --install /usr/bin/python python /usr/bin/python2.7 1
 ```
 
-Kernel source: [mi-msm8937/android_kernel_xiaomi_msm8937](https://github.com/mi-msm8937/android_kernel_xiaomi_msm8937)
+**Kernel Source:** [mi-msm8937/android_kernel_xiaomi_msm8937](https://github.com/mi-msm8937/android_kernel_xiaomi_msm8937)