docs: generic repo README; ld README keeps specifics + MakeMKV/Mike Chen credit

This commit is contained in:
Matthew Jackson
2026-06-22 16:53:14 -07:00
parent 607782ab64
commit dd5ebb599f
2 changed files with 10 additions and 8 deletions
+5 -7
View File
@@ -3,12 +3,12 @@
Unlocker plugins for [libfreemkv](https://github.com/freemkv/libfreemkv).
libfreemkv ships only the pluggable `Unlocker` trait + registry and stays
firmware-clean — it contains no concrete firmware-unlock code. Each crate in
this workspace implements one unlocker and is registered into libfreemkv by a
single line in the consuming binary:
firmware-clean — it contains no concrete unlock code. Each crate in this
workspace implements one unlocker and is registered into libfreemkv by a single
line in the consuming binary:
```rust
libfreemkv::register_unlocker(Box::new(freemkv_unlock_ld::LibreDrive::new()));
libfreemkv::register_unlocker(Box::new(my_unlocker::MyUnlocker::new()));
```
Removing an unlocker is deleting that one line and the dependency
@@ -16,8 +16,6 @@ Removing an unlocker is deleting that one line and the dependency
## Members
| Crate | Unlocker |
|-------|----------|
| [`ld`](ld/) (`freemkv-unlock-ld`) | LibreDrive — MediaTek MT1959 firmware unlock |
Each member is a self-contained unlocker plugin — see its own README for details.
License: AGPL-3.0-only.
+5 -1
View File
@@ -46,5 +46,9 @@ step; it is **never** automated by freemkv. This crate only performs the
non-persistent `#2` step — the microcode lives in RAM and is gone on power
cycle.
<!-- TODO(owner): MakeMKV attribution + thanks -->
## Credits
LibreDrive was created by **Mike Chen** and the **MakeMKV team**. This crate
builds on their work — our thanks and full credit to them for the LibreDrive
capabilities.