Updated README, fixed formatting, part 3.

This commit is contained in:
Ronald Farrer 2021-08-06 10:30:49 -07:00
parent de79f6a2aa
commit bd67878682

View file

@ -3,18 +3,18 @@ Gentoo Linux Overlay with Linux Surface kernel and other utilities from linux-su
# *This is a work in-progress, but most things do work!* # *This is a work in-progress, but most things do work!*
## Information ## Information
- *gentoo-surface-sources* gentoo-sources with surface patchsets applied - _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. - _iptsd_ utility is needed for touchscreen support. Enable the user and system services after you install.
- *libwacom-surface* improves touchscreen support. - _libwacom-surface_ improves touchscreen support.
- *surface-control* commandline utility to control certain aspects of your surface device. - _surface-control_ commandline utility to control certain aspects of your surface device.
- *surface-dtx-daemon* utility to control attach/detach of clipboard on Surface Book devices. - _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 - *libcamera* A complex camera support library for Linux, Android, and ChromeOS
## Installation ## Installation
Follow the Gentoo amd64 handbook (https://wiki.gentoo.org/wiki/Handbook:AMD64) pretty closely with these exceptions: Follow the Gentoo amd64 handbook (https://wiki.gentoo.org/wiki/Handbook:AMD64) pretty closely with these exceptions:
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. 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. 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) 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)) /dev/nvme0n1p1 on /boot/EFI type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=ascii,shortname=mixed,utf8,errors=remount-ro))
@ -30,5 +30,7 @@ Follow the Gentoo amd64 handbook (https://wiki.gentoo.org/wiki/Handbook:AMD64) p
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.) 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.)
This repo was initally forked from one by Parinthapat Parinz: https://github.com/Parinz/linux-surface-overlay but has since been updated, add to, and improved upon. *This repo was initally forked from one by Parinthapat Parinz: https://github.com/Parinz/linux-surface-overlay but has since been updated, add to, and improved upon.*
*_This repo/project is in no way supported by nor endorced by Gentoo or the SUrface Linux project(s)._*