From ebc954b1750d2b1b1463c3e7033806f0dec30f17 Mon Sep 17 00:00:00 2001 From: projectmoon Date: Tue, 15 Nov 2022 22:54:14 +0100 Subject: [PATCH] Update readme about new packages. --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3db9eba..19457b4 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ Available packages: - **sys-kernel/librem-ec-acpi**: An ebuild packaging the [Librem 14 EC ACPI kernel module][ec-acpi], necessary for proper functioning of the laptop's battery charging and function keys. + * **sys-power/librem-control**: A GTK application to control + parameters of the Librem EC (battery charge levels, etc). + * **sys-firmware/purism_ectool**: Tool for querying and flashing + Purism EC firmware images on certain Librem laptops. ## How to Add This Repository @@ -25,8 +29,8 @@ This overlay provides a dist-kernel (based on an accompanying updated version of `virtual/dist-kernel`. It is maintained and tested for my personal use on amd64. The Linux-libre kernel removes the ability for the Linux kernel to load firmware that -is not [Free Software][free-software]. The ebuild follows the current -stable gentoo-kernel for amd64. +is not [Free Software][free-software]. The ebuild roughly follows the +current stable gentoo-kernel for amd64. The libre kernel can be installed alongside other dist-kernels, and works with the `dist-kernel` and `initramfs` USE flags. The ebuild @@ -39,7 +43,8 @@ The kernel installed by this ebuild has the version suffix `-gnu-dist`, making it easy to determine which kernel it is. To install only the Linux firmware that meets the [Free Software -Definition][free-software], configure `/etc/portage/package.use` accordingly: +Definition][free-software], configure `/etc/portage/package.use` +accordingly: ``` # Install only libre firmware @@ -70,6 +75,14 @@ If you are not using a dist-kernel, when upgrading or installing a new kernel, you will need to do `emerge @modules-rebuild` to install the module for the new kernel. +### Librem Control and the Purism EC Tool + +These two appliations can be used to manipulate device-specific +features of the Librem 14, including the flashing of firmware images. +It is not recommended to use the EC tool from this repository for +flashing a firmware image. Instead, follow the official [firmware +flashing instrutions][ec-instructions]. + # Disclaimer @@ -80,3 +93,4 @@ So there may be issues with non-Free dependencies etc in some cases. [linux-libre]: https://www.fsfla.org/ikiwiki/selibre/linux-libre/ [free-software]: https://www.gnu.org/philosophy/free-sw.en.html#fs-definition [ec-acpi]: https://source.puri.sm/nicole.faerber/librem-ec-acpi-dkms +[ec-instructions]: https://puri.sm/projects/librem-ec/