From 57d0c6eda5d9db0b0b27dd3a2892ed4d07cb7ea1 Mon Sep 17 00:00:00 2001
From: timoxa0 <tima012007@gmail.com>
Date: Fri, 12 Jan 2024 19:07:56 +0500
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6062f1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Linux switch for Mi Pad 5 ([Windows Switch](https://github.com/entaromia/mi-pad5-windows-switch) fork)
+
+## Differences from original windows switch
+- Added Quick Settings tile
+- Added ability to dump android images
+- Flashes dtbo with boot
+
+## Installation
+1) Install app from [Releases](https://github.com/timoxa0/Switch2Linux-Nabu/releases)
+2) Open app and grant root access
+3) Tap "Dump android images"
+4) Move `android.boot.img` and `android.dtbo.img` to PC from `/sdcard/linux/`
+5) Place images:
+   ```
+   empty dtbo.img      -> /sdcard/linux/linux.dtbo.img
+   linux boot.img      -> /sdcard/linux/linux.boot.img
+   vbmeta_disabled.img -> /sdcard/linux/linux.vbmeta.img
+   ```
+6) Tap "Switch to Linux"
+7) Download s2a.zip from [Releases](https://github.com/timoxa0/Switch2Linux-Nabu/releases)
+8) Unzip s2a.zip in linux
+9) Place `android.boot.img` and `andoid.dtbo.img` to `s2a` folder
+10) Install switcher
+    ```console
+    sudo ./install.sh
+    ```
+11) Run Switch2Android and enter your password
+
+![Screenshot](./assets/screenshot.jpg "screenshot")