Guides

Getting started

  1. Find your exact model through Devices. Similar names do not necessarily mean compatible firmware. If your model is coming soon, please wait for a matching listing.
  2. On the device page, check the prerequisites and required stock version against your device. If anything does not match, stop and check the project author's instructions before continuing.
  3. Back up your files and settings as the device page and maker recommend. Note the current firmware version and find the official firmware and restore instructions before you start.
  4. Read the firmware card and the author's full instructions, including warnings and supported versions. Follow those instructions for your exact device; this guide is only a starting point.

Reading a firmware card

Dual-boot first

When a compatible project offers a way to run from an SD card or alongside stock firmware without overwriting it, prefer that option first. Check the author's instructions to see exactly what it changes and how to return to stock.

Even a card-based option can carry risks. Back up first, check your exact model and stock version, and do not assume that removing the card will undo every change.

Recovery

If something goes wrong, stop and take a breath. Do not panic-unplug or switch off during an update. Check the author's instructions for what to do when progress appears stuck.

Use the restore-to-stock box and official firmware link on your device page, following the maker's instructions for your exact model. If you are unsure, ask the project author through their repository or contact the device maker's support. Include your model, stock version and what happened; avoid sharing private information.

Recovery is not guaranteed. An unsuccessful update may leave a device unusable.

Glossary

Firmware
Software that controls how a device works.
Stock firmware
The official firmware supplied by the device maker.
Custom firmware
Firmware changed or made by someone other than the device maker.
Flash
Write firmware to a device's persistent memory.
Backup
A separate copy of files or settings you may want to restore.
Restore to stock
Return to official firmware using the maker's supported instructions, where possible.
Brick
A device that has become unusable; recovery may not be possible.
Beta
A version still being tested that may have unresolved problems.
Release
A version of a project its author has made available.
Repository
A project's online home for its code, instructions and issue reports.
Licence
The terms that say how a project may be used or shared.
Prerequisite
Something required before following a project's instructions.
Dual-boot
A way to choose between two systems when starting a device, where supported.
SD card
A removable memory card that can hold files or, for some projects, software.
Emulator
Software that imitates a device so software can run in a simulated environment.