projectmoon-overlay/README.md

80 lines
2.9 KiB
Markdown
Raw Normal View History

2021-08-06 10:02:18 +00:00
Personal Gentoo overlay, focusing mostly on needed tools and
2023-03-16 21:13:13 +00:00
compatibility for a libre version of Gentoo on the Librem 14 computer. A
handful of other pacakages are also provided.
2021-08-05 22:28:50 +00:00
2023-03-16 21:13:13 +00:00
Linux-libre and Librem-related packages:
2022-11-08 16:16:00 +00:00
- **sys-kernel/libre-kernel**: A dist-kernel built from the [Linux-libre
sources][linux-libre].
2022-11-10 13:48:17 +00:00
- **media-fonts/fonts-meta**: Modified version to remove non-Free
fonts from the dependencies.
2023-03-01 06:31:22 +00:00
- **sys-kernel/librem-ec-acpi**: An ebuild packaging the [Librem 14
2022-11-08 16:16:00 +00:00
EC ACPI kernel module][ec-acpi], necessary for proper functioning
of the laptop's battery charging and function keys.
2022-11-15 21:54:14 +00:00
* **sys-power/librem-control**: A GTK application to control
parameters of the Librem EC (battery charge levels, etc).
2023-02-28 13:19:23 +00:00
* **sys-apps/purism_ectool**: Tool for querying and flashing
2023-03-16 21:13:13 +00:00
Purism EC firmware images on certain Librem laptops.v
Other Packages:
- **dev-python/ecp**: Python implementation of Emacs RPC stack. Depends
on `orjson` or `orjson-bin` from the GURU (or another) overlay.
- **www-plugins/firefox-pwa-connector**: The native host connector for
the [PWAs for Firefox][ff-pwas] project.
2021-08-05 22:28:50 +00:00
2021-08-06 10:02:18 +00:00
## How to Add This Repository
2021-08-05 22:28:50 +00:00
2021-08-06 10:02:18 +00:00
Using eselect-repository:
```
# eselect repository add projectmoon git https://git.agnos.is/projectmoon/projectmoon-overlay
```
It usually a best practice to mask packages from overlays, except the ones you want:
In `/etc/portage/package.mask`:
```
*/*::projectmoon
```
Individual packages can be unmasked (and added to
2023-03-16 21:13:13 +00:00
`package.accept_keywords` if necessary). For instructions on unmasking
individual packages, see the relevant documentation below.
2022-11-08 16:16:00 +00:00
## The Linux-libre dist-kernel
2023-03-16 21:13:13 +00:00
*See [docs/Libre-Kernel.md](docs/Libre-Kernel.md).
2022-11-08 16:16:00 +00:00
This overlay provides a dist-kernel (based on
`sys-kernel/vanilla-kernel`) using the Linux-libre kernel sources, and
an accompanying updated version of `virtual/dist-kernel`. It is
maintained and tested for my personal use on amd64. The Linux-libre
2023-03-16 21:13:13 +00:00
kernel removes the ability for the Linux kernel to load firmware that is
not [Free Software][free-software]. The ebuild roughly follows the
2022-11-15 21:54:14 +00:00
current stable gentoo-kernel for amd64.
2022-11-08 16:16:00 +00:00
2023-03-16 21:13:13 +00:00
## Purism Librem Computer Packages
2021-08-05 22:28:50 +00:00
2023-03-16 21:13:13 +00:00
*See [docs/Librem.md](docs/Librem.md).*
2022-11-08 16:16:00 +00:00
2023-03-16 21:13:13 +00:00
This overlay contains packages for Purism's Librem computers, focusing
mostly on the Librem 14.
2021-08-05 22:28:50 +00:00
2023-03-16 21:13:13 +00:00
## Other Packages
2022-11-15 21:54:14 +00:00
2023-03-16 21:13:13 +00:00
*More documentation coming soon.*
2022-11-15 21:54:14 +00:00
2023-03-16 21:13:13 +00:00
Packages must be unmasked and added to `package.accept_keywords` as
necessary.
2022-11-10 13:48:17 +00:00
# Disclaimer
The ebuilds in this overlay are really only tested for my specific
use-case. I do not test every combination of USE flags, for example.
So there may be issues with non-Free dependencies etc in some cases.
2022-11-08 16:16:00 +00:00
[linux-libre]: https://www.fsfla.org/ikiwiki/selibre/linux-libre/
[free-software]: https://www.gnu.org/philosophy/free-sw.en.html#fs-definition
2021-08-05 22:28:50 +00:00
[ec-acpi]: https://source.puri.sm/nicole.faerber/librem-ec-acpi-dkms
2022-11-15 21:54:14 +00:00
[ec-instructions]: https://puri.sm/projects/librem-ec/
2023-03-16 21:13:13 +00:00
[ff-pwas]: https://github.com/filips123/PWAsForFirefox