16 changed files with 480 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1 @@
+to_releases/
--- a/README-RU.md
+++ b/README-RU.md
@ -0,0 +1,29 @@
+<img align="right" src="./assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Запуск Linux на Xiaomi Pad 5
+## Язык
+Русский | [English](README.md)
+
+## ⚠️ Предупреждение
+Мы не несем ответственности за сломанные устройства, отсутствующие разделы, плохих работников на линии производства Xiaomi, мёртвые карты памяти, мёртвые чипы управления питанием, мёртвую ОЗУ, мёртвые контроллеры экрана, мёртвые процессоры, мёртвых кошек и собак и ядерные войны.
+
+Установка Linux - опасный процесс, делайте это на свой страх и риск и осторожно следуйте инструкции.
+Этот проект находится на ранней стадии, все файлы здесь были предоставлены другими пользователями, здесь вы найдете руководство с рабочими файлами, которые нам удалось получить. Это деликатный процесс, делайте это на свой страх и риск и внимательно следуйте всем шагам!
+
+**ЕСЛИ ВЫ БОИТЕСЬ МОДИФИЦИРОВАТЬ СВОЙ ПЛАНШЕТ ИЛИ БОИТЕСЬ ЕГО СЛОМАТЬ - НЕМЕДЛЕННО ПРЕКРАТИТЕ ЧИТАТЬ!!! ВЫ БЫЛИ ПРЕДУПРЕЖДЕНЫ, В СЛУЧАЕ ПОЛОМКИ ОТВЕТСТВЕННОСТЬ ЛЕЖИТ НА ВАС!!! ВЫ БЫЛИ ПРЕДУПРЕЖДЕНЫ!!!**
+
+## Начнём
+
+- [Установка](guide/Russian/prepare-ru.md)
+
+- [Удаление](guide/Russian/uninstall-ru.md)
+
+## Разное
+
+- [Статус Проекта](guide/Russian/status-ru.md)
+
+- [Переустановка](guide/Russian/reinstall-ru.md)
+
+- [Доступные дистрибутивы](guide/Russian/distros-ru.md)
+
--- a/README.md
+++ b/README.md
@ -1 +1,28 @@
-### Moved to [Github](https://github.com/nabu-alarm/installation-guide/tree/main)
+<img align="right" src="./assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Running Linux on the Xiaomi Pad 5
+## Language 
+[Русский](README-RU.md) | English
+
+## ⚠️ Warning
+We're not responsible for bricked devices, missing recovery partitions, dead xiaomi factoryline workers cowboys, dead microSD cards, dead pmics, dead ram, dead display ics, dead cpus, any xiaomi shenanigans, dead cats or dogs, nuclear wars or you getting fired because you forgot to boot back in to android for the alarm.
+
+This project is in an early stage, all the files here have been contributed by other users, here you will find a guide with the working files we managed to get. This is a delicate process, do it under your own risk and follow all the steps carefully.
+
+**IF YOU AREN'T COMFORTABLE MODDING YOUR TABLET OR ITS PARTITION TABLE OR YOU ARE PARANOID OF BRICKING YOUR DEVICE CLICK AWAY NOW!!! YOU HAVE BEEN WARNED, YOU ARE ON YOUR OWN IF YOU BRICK YOUR DEVICE!!! AGAIN! YOU HAVE BEEN WARNED!!!**
+
+## Get Started
+
+- [Installation](guide/English/prepare-en.md)
+
+- [Uninstallation](guide/English/uninstall-en.md)
+
+
+## Miscellaneous
+
+- [Project Status](guide/English/status-en.md)
+
+- [Reinstallation](guide/English/reinstall-en.md)
+
+- [Available distros](guide/English/distros-en.md)
--- a/assets/nabu.png
+++ b/assets/nabu.png
--- a/guide/English/distros-en.md
+++ b/guide/English/distros-en.md
@ -0,0 +1,11 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Running Linux on the Xiaomi Pad 5
+
+#### Available distros
+
+- [Ubuntu 23.10](https://timoxa0.su/share/nabu/images/v1/ubuntu.img.xz)
+
+- [Arch Linux ARM](https://timoxa0.su/share/nabu/images/v1/arch.img.xz)
+
+- [Fedora 39](https://timoxa0.su/share/nabu/images/v1/fedora.img.xz)
--- a/guide/English/install-en.md
+++ b/guide/English/install-en.md
@ -0,0 +1,63 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Running Linux on the Xiaomi Pad 5
+
+## [←](prepare-en.md) Installing Linux
+
+### Prerequisites
+- Brain
+  
+- Rooted Android
+  
+- [Rootfs image](./distros-en.md)
+
+- [Kernel image](https://timoxa0.su/share/nabu/images/v1/linux-6.1.10-nabu-gc033672c6f54.boot.img)
+
+- [UEFI installer](https://timoxa0.su/share/nabu/manual/uefi-installer-nabu.zip)
+
+### Installation
+
+#### Reboot to fastboot to install Linux
+
+#### Flash Linux image via fastboot
+```
+fastboot flash linux <rootfs.img>
+```
+> Replace <rootfs.img> with path to rootfs image
+
+#### Reboot to bootloader
+```
+fastboot reboot bootloader
+```
+
+#### Erase dtbo
+```
+fastboot erase dtbo
+```
+
+#### Temporary boot Linux from PC
+```
+fastboot boot <linux-boot.img>
+```
+> Replace <linux-boot.img> with path to kernel image
+> Do dot disconnect tablet from pc until it boots to initial setup
+
+#### Complete initial setup and reboot the tablet into bootloader
+
+#### Restore dtbo backup
+```
+fastboot flash dtbo <dtbo.img>
+```
+> Replace <dtbo.img> with path to dtbo backup
+
+#### Reboot tablet into android
+```sh
+fastboot reboot
+```
+
+### Set up dualboot
+
+#### Flash UEFI installer via Magisk or recovery
+> After rebooting, a menu will appear in which you can navigate using the volume and power buttons
+
+### Done!
--- a/guide/English/prepare-en.md
+++ b/guide/English/prepare-en.md
@ -0,0 +1,58 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Running Linux on the Xiaomi Pad 5
+
+## Preparing your device [→](install-en.md)
+
+### Prerequisites
+- Brain
+
+- [Vbmeta image](https://timoxa0.su/share/nabu/manual/vbmeta_disabled.img)
+
+- [Recovery Image](https://timoxa0.su/share/nabu/manual/orangefox.img)
+
+- [ADB & Fastboot](https://developer.android.com/studio/releases/platform-tools)
+
+### Notes:
+> [!Warning]\
+> All your data will be erased! Backup now if needed.
+> 
+> These commands have been tested.
+> 
+> Ignore `udevadm` warnings
+> 
+> Do not run the same command twice
+>
+> Do not run all commands at once, execute them in order!
+
+#### Reboot tablet to bootloader
+
+#### Flash vbmeta_disabled.img via fastboot
+```
+fastboot flash vbmeta_ab <vbmeta_disabled.img>
+```
+> Replace <vbmeta_disabled.img> with path to vbmeta_disabled.img
+
+#### Boot Orange Fox recovery through PC
+```
+fastboot boot <recovery.img>
+```
+> Replace <recovery.img> with path to recovery.img
+
+#### Repartition yout device
+```
+adb shell partition [TARGET LINUX SIZE IN GB]
+```
+
+#### Create dtbo backup
+```
+adb shell backupdtbo
+adb pull /tmp/dtbo.img
+```
+> Backup will be saved to current directory
+
+#### Check if Android still starts
+Just restart the tablet, and see if Android still works. If isn't boot or looping or animation, wipe data in recovery.
+
+### [Next step: Installing Linux](/guide/English/install-en.md)
--- a/guide/English/reinstall-en.md
+++ b/guide/English/reinstall-en.md
@ -0,0 +1,15 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Running Linux on the Xiaomi Pad 5
+
+## Reinstallation [→](install-en.md)
+
+### Reinstalling Linux if something goes wrong
+
+- If you don't like your linux version or you've bricked your linux install, or anything else, you would probably just reinstall Linux. Thankfully this process is very easy.
+
+- If you haven't restored your partition table, you can use this guide with your existing partitions.
+
+#### Follow installation guide and reflash linux image again
+## [Next step: Reinstalling Linux](/guide/English/install-en.md)
--- a/guide/English/status-en.md
+++ b/guide/English/status-en.md
@ -0,0 +1,38 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Running Linux on the Xiaomi Pad 5
+
+## Project Status
+
+Stable. Some components don't work.
+
+#### Features
+
+- [x] Suspend / Sleep Mode
+- [x] Audio
+- [x] Battery status
+- [x] Bluetooth
+- [x] Brightness
+- [x] Slow charging
+- [x] Fast charging (Fixed in latest kernel)
+- [x] Display
+- [x] GPU
+- [x] Touchscreen
+- [x] UFS
+- [x] USB
+- [x] Wi-Fi
+- [x] Xiaomi Keyboard support
+- [ ] Xiaomi Pen support
+- [ ] Xiaomi Pen charging support
+- [ ] Microphone
+- [ ] Location
+- [ ] Flashlight
+- [ ] Camera
+
+#### Sensors
+
+- [ ] Accelerometer
+- [ ] Gyroscope
+- [x] Magnetometer (Fixed in latest kernel)
+- [ ] Proximity
+- [ ] Light sensor
--- a/guide/English/uninstall-en.md
+++ b/guide/English/uninstall-en.md
@ -0,0 +1,28 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Running Linux on the Xiaomi Pad 5
+
+## Uninstallation
+
+### Why is this needed?
+
+If you want to uninstall linux this is used instead of deleting partitions manually to avoid human error + writing a whole dedicated guide to just uninstalling.
+
+If you want to relock your bootloader you'll need your partition table to be stock.
+
+### Prerequisites
+
+- [ADB & Fastboot](https://developer.android.com/studio/releases/platform-tools)
+- [gpt_both0.bin](https://timoxa0.su/share/nabu/manual/gpt_both0.bin)
+
+### Restore GPT
+> Replace ```<gpt_both0.bin>``` with the path to the gpt_both0.bin file.
+
+```cmd
+fastboot flash partition:0 <gpt_both0.bin>
+```
+
+### Erase userdata to avoid bootloop and restore FS size
+```cmd
+fastboot -w
+```
--- a/guide/Russian/distros-ru.md
+++ b/guide/Russian/distros-ru.md
@ -0,0 +1,11 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Linux на Xiaomi Pad 5
+
+#### Доступные дистрибутивы
+
+- [Ubuntu 23.10](https://timoxa0.su/share/nabu/images/v1/ubuntu.img.xz)
+
+- [Arch Linux ARM](https://timoxa0.su/share/nabu/images/v1/arch.img.xz)
+
+- [Fedora 39](https://timoxa0.su/share/nabu/images/v1/fedora.img.xz)
--- a/guide/Russian/install-ru.md
+++ b/guide/Russian/install-ru.md
@ -0,0 +1,63 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Linux на Xiaomi Pad 5
+
+## [←](prepare-ru.md) Установка Linux
+
+### Требования
+- Мозги
+
+- Android с root-правами
+  
+- [Образ rootfs](./distros-ru.md)
+
+- [Образ ядра](https://timoxa0.su/share/nabu/images/v1/linux-6.1.10-nabu-gc033672c6f54.boot.img)
+
+- [Установщик UEFI](https://timoxa0.su/share/nabu/manual/uefi-installer-nabu.zip)
+
+### Установка
+
+#### Перезапустите планшет в fastboot для прошивки
+
+#### Прошейте образ Linux через fastboot
+```
+fastboot flash linux <rootfs.img>
+```
+> Замените <rootfs.img> на путь к образу rootfs
+
+#### Перезапуститесь в bootloader
+```
+fastboot reboot bootloader
+```
+
+#### Очистите dtbo
+```
+fastboot erase dtbo
+```
+
+#### Временно запустите Linux с ПК
+```
+fastboot boot <linux-boot.img>
+```
+> Замените <linux-boot.img> на путь к образу ядра
+> Не отключайте планшет от компьютера, пока он не загрузится.
+
+#### Пройдите первоначальную настройку и перезагрузите планшет в bootloader
+
+#### Восстановите резервную копию dtbo
+```
+fastboot flash dtbo <dtbo.img>
+```
+> Замените <dtbo.img> на путь к резервной копии dtbo
+
+#### Перезагрузите планшет в android
+```
+fastboot reboot
+```
+
+### Настройка dualboot
+
+#### Прошейте установщик UEFI через Magisk или recovery
+> После перезагрузки появляется меню, в котором вы можете ориентироваться, используя кнопки громкости и питания
+
+### Готово!
--- a/guide/Russian/prepare-ru.md
+++ b/guide/Russian/prepare-ru.md
@ -0,0 +1,58 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Linux на Xiaomi Pad 5
+
+## Подготовка устройства [→](install-ru.md)
+
+### Требования:
+- Мозги
+
+- [Образ vbmeta](https://timoxa0.su/share/nabu/manual/vbmeta_disabled.img)
+
+- [Образ рекавери](https://timoxa0.su/share/nabu/manual/orangefox.img)
+
+- [ADB и Fastboot](https://developer.android.com/studio/releases/platform-tools)
+
+### Примечание:
+> [!WARNING]
+> Все пользовательские файлы будут стерты! Создайте резервную копию, если это необходимо.
+> 
+> Эти команды были протестированы.
+> 
+> Игнорируйте ошибки `udevadm`.
+> 
+> Не выполняйте одну команду дважды.
+>
+> Не запускайте все команды сразу, выполняйте их по очереди!
+
+#### Перезагрузите планшет в fastboot
+
+#### Прошейте vbmeta_disabled.img
+```
+fastboot flash vbmeta_ab <vbmeta_disabled.img>
+```
+> Замените <vbmeta_disabled.img> на путь к vbmeta_disabled.img
+
+#### Запустите recovery с компьютера при помощи команды
+```
+fastboot boot <recovery.img>
+```
+> Замените <recovery.img> на путь к recovery.img
+
+#### Выполните переразметку
+```
+adb shell partition [размер раздела под linux в GB]
+```
+
+#### Сделайте резервную копию dtbo
+```
+adb shell backupdtbo
+adb pull /tmp/dtbo.img
+```
+> Резервная копия будет создана в текущей директории
+
+#### Проверьте, запускается ли Android
+Просто перезапустите планшет и убедитесь, что Android запускается. Если система не запускается или вы получили бутлуп, отформатируйте `data` в recovery.
+
+### [Следующий шаг: установка Linux](/guide/Russian/install-ru.md)
--- a/guide/Russian/reinstall-ru.md
+++ b/guide/Russian/reinstall-ru.md
@ -0,0 +1,13 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+
+# Linux на Xiaomi Pad 5
+
+## Переустановка [→](install-ru.md)
+### Переустановка Linux если что-то пошло не так
+
+- Если текущая версия Linux не подходит или была испорчена, вероятно, Вам поможет переустановка Linux, благо это довольно простой процесс.
+- Если Вы не восстанавливали таблицу разделов, то используйте этот гайд с текущей таблицей разделов.
+
+#### Следуя инструкции по установка, выполните установку заново
+### [Следующий шаг: Установка Linux](/guide/Russian/install-ru.md)
--- a/guide/Russian/status-ru.md
+++ b/guide/Russian/status-ru.md
@ -0,0 +1,38 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Linux на Xiaomi Pad 5
+
+## Статус проекта
+
+Стабильный. Некоторые компоненты ещё не функционируют.
+
+#### Особенности
+
+- [x] Режим ожидания
+- [x] Аудио
+- [x] Статус батареи
+- [x] Bluetooth
+- [x] Яркость
+- [x] Зарядка
+- [x] Быстрая зарядка (Починена в последнем ядре)
+- [x] Дисплей
+- [x] Видеочип
+- [x] Сенсорный экран
+- [x] Память
+- [x] USB
+- [x] Wi-Fi
+- [x] Чехол-клавиатура Xiaomi
+- [ ] Cтилус Xiaomi
+- [ ] Зарядка стилуса Xiaomi
+- [ ] Микрофон
+- [ ] Местоположение
+- [ ] Фонарик
+- [ ] Камера
+
+#### Сенсоры
+
+- [ ] Акселерометр
+- [ ] Гироскоп
+- [x] Магнетометр (Починен в последнем ядре)
+- [ ] Датчик приближения
+- [ ] Датчик освещенности
--- a/guide/Russian/uninstall-ru.md
+++ b/guide/Russian/uninstall-ru.md
@ -0,0 +1,26 @@
+<img align="right" src="../../assets/nabu.png" width="425" alt="Linux Running On A Xiaomi Pad 5">
+
+# Linux на Xiaomi Pad 5
+
+## Удаление
+
+Если вы хотите удалить Linux, используйте данный упрощенный метод вместо ручного удаления разделов чтобы исключить риск ошибки.
+
+Если вы хотите заблокировать загрузчик обратно, убедитесь что таблица разделов находится в заводском состоянии.
+
+### Требования
+
+- [ADB и Fastboot](https://developer.android.com/studio/releases/platform-tools)
+- [gpt_both0.bin](https://timoxa0.su/share/nabu/manual/gpt_both0.bin)
+
+### Восстановление GPT
+> Замените ```<gpt_both0.bin>``` путём к файлу `gpt_both0.bin`.
+
+```cmd
+fastboot flash partition:0 <gpt_both0.bin>
+```
+
+### Очистите раздел `userdata` чтобы избежать цикличной перезагрузки и восстановить размер файловой системы
+```cmd
+fastboot -w
+```