docs: generic repo README; ld README keeps specifics + MakeMKV/Mike Chen credit
This commit is contained in:
@@ -3,12 +3,12 @@
|
|||||||
Unlocker plugins for [libfreemkv](https://github.com/freemkv/libfreemkv).
|
Unlocker plugins for [libfreemkv](https://github.com/freemkv/libfreemkv).
|
||||||
|
|
||||||
libfreemkv ships only the pluggable `Unlocker` trait + registry and stays
|
libfreemkv ships only the pluggable `Unlocker` trait + registry and stays
|
||||||
firmware-clean — it contains no concrete firmware-unlock code. Each crate in
|
firmware-clean — it contains no concrete unlock code. Each crate in this
|
||||||
this workspace implements one unlocker and is registered into libfreemkv by a
|
workspace implements one unlocker and is registered into libfreemkv by a single
|
||||||
single line in the consuming binary:
|
line in the consuming binary:
|
||||||
|
|
||||||
```rust
|
```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
|
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
|
## Members
|
||||||
|
|
||||||
| Crate | Unlocker |
|
Each member is a self-contained unlocker plugin — see its own README for details.
|
||||||
|-------|----------|
|
|
||||||
| [`ld`](ld/) (`freemkv-unlock-ld`) | LibreDrive — MediaTek MT1959 firmware unlock |
|
|
||||||
|
|
||||||
License: AGPL-3.0-only.
|
License: AGPL-3.0-only.
|
||||||
|
|||||||
+5
-1
@@ -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
|
non-persistent `#2` step — the microcode lives in RAM and is gone on power
|
||||||
cycle.
|
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.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user