diff --git a/README.md b/README.md index 5cdc358..d616c52 100644 --- a/README.md +++ b/README.md @@ -33,25 +33,17 @@ To run the CLI via `cargo` directly, remember to add arguments after an extra `--`; i.e., to print the general help, invoke `cargo run --relase -- -h`, or, for a subcommand, e.g. `cargo run --relase -- me clean -h`. -## Milestones - -- [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand - - mimic the `me_cleaner` CLI, using similar+same arguments and switches for - compatibility -- [x] port the logic to Rust, using `me_cleaner`-edited images as test fixtures - - NOTE: committing the test fixtures would be big and a potential license - issue; instead, add notes on how to reproduce them, via public vendor - images and extraction utilities (e.g. from Lenovo) - - [x] step 1: port core logic to produce the same output as `me_cleaner` for - Lenovo ThinkPad X230 + X270 - - [x] step 2: full feature parity with `me_cleaner` -- [x] expand the documentation - - [x] higher-level view on Intel platform boot flows - - [x] how the Intel data structures work, in prose - - [x] adding support for more platforms and variants -- [ ] work out a reusable library, i.e., a Rust crate for - - [x] turn all `unwrap()`s into `Option`/`Result`; add lint rule - - [ ] add bounds checks - - [ ] publish the crate +## TODOs + - [ ] sync up; has another patch that coreboot is missing, doing rework and adding ME Gen 1 support +- [ ] [IFWI](https://github.com/platform-system-interface/intel_fw/issues/80) + format support + +## Funding + +The [initial work](milestones.md#initial_work) has been sponsored through the +first [Open Call by the Open Source Firmware Foundation](https://www.osfw.foundation/funding/small-scale-high-impact-firmware-contributions-2025/). We highly appreciate +their support that made a first release of this project possible. + +![Open Source Firmware Foundation Logo](docs/osff_logo_400.png) diff --git a/docs/osff_logo_400.png b/docs/osff_logo_400.png new file mode 100644 index 0000000..27f74f3 Binary files /dev/null and b/docs/osff_logo_400.png differ diff --git a/milestones.md b/milestones.md new file mode 100644 index 0000000..2ccc100 --- /dev/null +++ b/milestones.md @@ -0,0 +1,22 @@ +# Milestones + +## Initial work + +- [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand + - mimic the `me_cleaner` CLI, using similar+same arguments and switches for + compatibility +- [x] port the logic to Rust, using `me_cleaner`-edited images as test fixtures + - NOTE: committing the test fixtures would be big and a potential license + issue; instead, add notes on how to reproduce them, via public vendor + images and extraction utilities (e.g. from Lenovo) + - [x] step 1: port core logic to produce the same output as `me_cleaner` for + Lenovo ThinkPad X230 + X270 + - [x] step 2: full feature parity with `me_cleaner` +- [x] expand the documentation + - [x] higher-level view on Intel platform boot flows + - [x] how the Intel data structures work, in prose + - [x] adding support for more platforms and variants +- [x] work out a reusable library, i.e., a Rust crate for + - [x] turn all `unwrap()`s into `Option`/`Result`; add lint rule + - [x] add bounds checks + - [x] publish the crate