Update ReadMe

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..40a07f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# Device Tree for OnePlus 6 (enchilada)
+
+The OnePlus 6 (codenamed _"enchilada"_) is a flagship smartphone from OnePlus.
+It was released in May 2018.
+
+| Basic                   | Spec Sheet                                                                                                                     |
+| -----------------------:|:------------------------------------------------------------------------------------------------------------------------------ |
+| CPU                     | Octa-core (4x2.8 GHz Kryo 385 Gold & 4x1.7 GHz Kryo 385 Silver)                                                                |
+| Chipset                 | Qualcomm SDM845 Snapdragon 845                                                                                                 |
+| GPU                     | Adreno 630                                                                                                                     |
+| Memory                  | 6/8 GB RAM                                                                                                                     |
+| Shipped Android Version | 8.1                                                                                                                            |
+| Storage                 | 64/128/256 GB                                                                                                                  |
+| Battery                 | Non-removable Li-Po 3300 mAh battery                                                                                           |
+| Display                 | Optic AMOLED, 1080 x 2280 pixels, 19:9 ratio (~402 ppi density)                                                                |
+| Camera (Back)           | Dual: 16 MP (f/1.7, 27mm, 1/2.6", 1.22µm, gyro-EIS, OIS) + 20 MP (16 MP effective, f/1.7, 1/2.8", 1.0µm), PDAF, dual-LED flash |
+| Camera (Front)          | 16 MP (f/2.0, 25mm, 1/3", 1.0µm), gyro-EIS, Auto HDR, 1080p                                                                    |
+
+Copyright 2018 - The LineageOS Project.
+
+![OnePlus 6](https://cdn2.gsmarena.com/vv/pics/oneplus/oneplus-6-5.jpg "OnePlus 6")
+
+
+## Compile
+
+First checkout minimal twrp with omnirom tree:
+
+```
+repo init -u git://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git -b twrp-8.1
+repo sync
+```
+
+Then add these projects to .repo/manifest.xml:
+
+```xml
+<project path="device/oneplus/enchilada" name="mauronofrio/android_device_oneplus_enchilada" remote="github" revision="android-8.1" />
+```
+
+To make all works you need to modify the buildinfo.sh in build/tools
+echo "ro.build.version.release=$PLATFORM_VERSION"
+echo "ro.build.version.security_patch=$PLATFORM_SECURITY_PATCH"
+to
+echo "ro.build.version.release_orig=$PLATFORM_VERSION"
+echo "ro.build.version.security_patch_orig=$PLATFORM_SECURITY_PATCH"
+
+And you need to increase the PLATFORM_VERSION to 16.1.0 in build/core/version_defaults.mk to override Google's anti-rollback features
+
+```
+
+Finally execute these:
+
+```
+. build/envsetup.sh
+export ALLOW_MISSING_DEPENDENCIES=true # Only if you use minimal twrp tree.
+lunch omni_enchilada-eng 
+mka adbd recoveryimage 
+```
+
+To test it:
+
+```
+fastboot boot out/target/product/enchilada/recovery.img
+```
+## Thanks
+```
+- @engstk to make TWRP works on PIE
+- @joemossjr16 for some tips
+- @Dees-Troy for some tips
+- @wuxianlin for initial bring up
+