gentoo-linux-surface-overlay/README.md

Gentoo Linux Overlay with Linux Surface kernel and other utilities from linux-surface repo.

This is a work in-progress.

# 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.
- *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.
- *libcamera* A complex camera support library for Linux, Android, and ChromeOS

# Installation

Follow the Gentoo handbook pretty closely with these exceptions:

#. Disable secure boot (at least until after the install is finished.)

# Post-Installation
#. Add this overlay (i.e. 'layman -a gentoo-linux-surface-overlay')
#. emerge at least gentoo-surface-sources, iptsd, libwacom-surface, and surface-control (libcamera if you want camera support.)

# Configuraton
#. For the kernel I have includeed a sample config in /usr/src/gentoo-surface-sources-<version>/EXAMPLE.config that you can cp to .config and use as-is if you like
#. 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")
#. 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.
First commit. 2021-07-27 12:35:19 -07:00			`Gentoo Linux Overlay with Linux Surface kernel and other utilities from linux-surface repo.`

Updated readme. 2021-08-03 21:10:40 -07:00			`This is a work in-progress.`

First commit. 2021-07-27 12:35:19 -07:00			`# 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.`
			`- surface-control commandline utility to control certain aspects of your surface device.`
Updated README. 2021-08-06 10:09:21 -07:00			`- surface-dtx-daemon utility to control attach/detach of clipboard on Surface Book devices.`
Updated readme. 2021-08-05 11:04:25 -07:00			`- libcamera A complex camera support library for Linux, Android, and ChromeOS`
First commit. 2021-07-27 12:35:19 -07:00
Updated README. 2021-08-06 10:09:21 -07:00			`# Installation`

			`Follow the Gentoo handbook pretty closely with these exceptions:`

			`#. Disable secure boot (at least until after the install is finished.)`

			`# Post-Installation`
			`#. Add this overlay (i.e. 'layman -a gentoo-linux-surface-overlay')`
			`#. emerge at least gentoo-surface-sources, iptsd, libwacom-surface, and surface-control (libcamera if you want camera support.)`

			`# Configuraton`
			`#. For the kernel I have includeed a sample config in /usr/src/gentoo-surface-sources-<version>/EXAMPLE.config that you can cp to .config and use as-is if you like`
			`#. 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")`
			`#. 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.`
First commit. 2021-07-27 12:35:19 -07:00