From de79f6a2aa62e8521dea8b650d9e5dc3160db417 Mon Sep 17 00:00:00 2001 From: Ronald Farrer Date: Fri, 6 Aug 2021 10:26:02 -0700 Subject: [PATCH] Updated README, added additional steps. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fa87a4f..3776240 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ Gentoo Linux Overlay with Linux Surface kernel and other utilities from linux-surface repo. -This is a work in-progress. +# *This is a work in-progress, but most things do work!* -# Information +## Information - *gentoo-surface-sources* gentoo-sources with surface patchsets applied - *iptsd* utility is needed for touchscreen support. Enable the user and system services after you install. - *libwacom-surface* improves touchscreen support. @@ -10,17 +10,21 @@ This is a work in-progress. - *surface-dtx-daemon* utility to control attach/detach of clipboard on Surface Book devices. - *libcamera* A complex camera support library for Linux, Android, and ChromeOS -# Installation +## Installation -Follow the Gentoo handbook pretty closely with these exceptions: +Follow the Gentoo amd64 handbook (https://wiki.gentoo.org/wiki/Handbook:AMD64) pretty closely with these exceptions: -1. Disable secure boot (at least until after the install is finished.) +1. You *need* systemd and a *systemd profile*. I'm a big fan of OpenRC and user choice, but the non-systemd init days in the desktop world are numbered - for better or worse! +1. Disable secure boot (at least until after the install is finished, if you don't you will get stuck because the handbook does not cover signing kernel nor adding keys to mok.) +1. You will need to mount your EFI partition (i.e. /dev/nvme0n1p1) somewhere under /boot (example: efivarfs on /sys/firmware/efi/efivars type efivarfs (rw,nosuid,nodev,noexec,relatime) +/dev/nvme0n1p1 on /boot/EFI type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=ascii,shortname=mixed,utf8,errors=remount-ro)) +1. grub-install will be something like: grub-install --target=x86_64-efi --efi-directory=/boot/EFI (you'll need to adjust for your specific setup) -# Post-Installation +## Post-Installation 1. Add this overlay (i.e. 'layman -a gentoo-linux-surface-overlay') -1. emerge at least gentoo-surface-sources, iptsd, libwacom-surface, and surface-control (libcamera if you want camera support.) +1. emerge at least gentoo-surface-sources, iptsd, libwacom-surface, and surface-control (libcamera if you want camera support and surface-dtx-daemon if you have a surface book.) -# Configuraton +## Configuraton 1. For the kernel I have includeed a sample config in /usr/src/gentoo-surface-sources-/EXAMPLE.config that you can cp to .config and use as-is if you like 1. If you want keyboard to work correctly during boot the easiest solution is to just include all kernel modules in the initrd image (for genkernel users add/edit /etc/genkernel.conf: ALLRAMDISKMODULES="yes") 1. If you have a surface book, enable the dtx daemons (system and user): 'systemctl enable --now surface-dtx-daemon.service' (as root) and 'systemctl enable --user --now surface-dtx-userd.service' (as your regular non-root user.)