From 502d05fcf628c76ccdbecbd645f2808529e55b5d Mon Sep 17 00:00:00 2001 From: Kevin J Hoerr Date: Sat, 11 Nov 2023 17:19:50 -0500 Subject: [PATCH] framework: Add notice to README.md --- framework/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/framework/README.md b/framework/README.md index b1cc561..2dd58aa 100644 --- a/framework/README.md +++ b/framework/README.md @@ -1,4 +1,9 @@ -# [Framework Laptop 13](https://frame.work/) +# NOTE: Structure changes from 2023-11-11 + +Please read the [Deprecated Behaviour README](./OLD-BEHAVIOUR-DEPRECATION.md) to understand how some structural changes to +the code might affect you! + +# [Framework Laptops](https://frame.work/) ## Updating Firmware @@ -14,4 +19,17 @@ Then run $ fwupdmgr update ``` -[Latest Update](https://fwupd.org/lvfs/devices/work.frame.Laptop.TGL.BIOS.firmware) +## Common Modules + +For the Framework 13 laptops, there are common configuration modules available under the `13-inch/common/` directory, +including some modules specific to AMD- or Intel-based laptops. By preference, there will already be a specialised +module for your model's configuration. Otherwise, it can be added alongside the existing modules. + +## Support Tools + +### fw-ectool + +There is a `fw-ectool` package available in nixpkgs-unstable that provides some system configuration options via the EC. +This ectool only works with the Intel-based Framework laptops at present, as the Framework EC for AMD-based mainboards +is based on the Zephyr port of the ChromeOS EC, which involves a slightly changed communication interface. +