openwrt-xiaomi/xmir-patcher

Call for Documentation

maxpill opened this issue · 0 comments

Issue Description

The XMiR-Patcher repository provides a valuable tool for patching Xiaomi router firmware, but it lacks comprehensive documentation on how to utilize the tool after running it to flash the firmware. This issue aims to request the creation of a detailed guide to help users successfully flash their firmware after executing the patcher.

Current State

The repository's README file provides very limited, but enough instructions for running the patcher on Windows, Linux, and Mac OS. However, it does not offer any kind of guidance on the subsequent steps required to flash the firmware nor on how to use the patcher functionalities.

Request

We kindly request that the repository maintainers or contributors create a step-by-step guide on how to flash the firmware after running the XMiR-Patcher. This guide should include:

  • Detailed instructions for each supported operating system (Windows, Linux, and Mac OS)
  • Screenshots or diagrams to illustrate the process, if possible
  • Troubleshooting tips for common issues that may arise during the flashing process
Screenshot 2024-08-26 at 12 26 37