From f443200b25e42ae68b53fc8e8553bdcf21bccb01 Mon Sep 17 00:00:00 2001
From: projectmoon <projectmoon@agnos.is>
Date: Sun, 11 Aug 2024 23:46:12 +0200
Subject: [PATCH] Input Leap docs

---
 README.md          | 20 +++++++++++++----
 docs/Input-Leap.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 4 deletions(-)
 create mode 100644 docs/Input-Leap.md

diff --git a/README.md b/README.md
index aa14b2e..3f0e279 100644
--- a/README.md
+++ b/README.md
@@ -16,10 +16,8 @@ Linux-libre and Librem-related packages:
    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.
+  - **x11-misc/input-leap**: Updated ebuild of input-leap
+    (Barrier/Synergy virtual KVM switch fork) that supports libei.
 
 ## How to Add This Repository
 
@@ -59,6 +57,20 @@ current stable gentoo-kernel for amd64.
 This overlay contains packages for Purism's Librem computers, focusing
 mostly on the Librem 14.
 
+## Input Leap
+
+*See [docs/Input-Leap.md](docs/Input-Leap.md)*
+
+This overlay contains a working, updated ebuild for Input Leap, a fork
+of Barrier (itself a fork of Synergy), which is a "virtual KVM switch",
+allowing you to share a keyboard and mouse between several computers
+over the network.
+
+The most important things about Input Leap:
+
+ - It is Maintained.
+ - It supports Wayland.
+
 ## Other Packages
 
 *More documentation coming soon.*
diff --git a/docs/Input-Leap.md b/docs/Input-Leap.md
new file mode 100644
index 0000000..cf9425d
--- /dev/null
+++ b/docs/Input-Leap.md
@@ -0,0 +1,56 @@
+# Input Leap
+
+This overlay has a working, updated version of Input Leap, a fork of
+Barrier (itself a fork of Synergy), which is a "virtual KVM switch",
+allowing you to share a keyboard and mouse between several computers
+over the network.
+
+The most important things about Input Leap:
+ - Maintained.
+ - Supports Wayland.
+
+## Project Status
+
+Input Leap is technically alpha quality, because it does not yet have a
+stable release. Thus, the ebuild is a `9999` version ebuild.
+
+## Setup
+
+To use this overlay's version of Input Leap, unmask the following packages:
+
+```
+dev-libs/libportal::projectmoon
+x11-misc/input-leap::projectmoon
+```
+
+Then add the package accept keywords:
+
+```
+dev-libs/libportal::projectmoon
+x11-misc/input-leap::projectmoon **
+```
+
+*The double star allows unstable git builds.*
+
+## USE Flags
+
+This ebuild of Input Leap supports Wayland integration via `libei`, onb
+supported compositors (notably, wlroots is apparently not supported by
+upstream). To use the `libei` integration, you must have a version of
+`libportal` with Input Capture support, which at time of writing
+(libportal 0.7.1) is not yet released.
+
+This overlay contains a custom ebuild of `dev-libs/libportal` that can
+enable Input Capture.
+
+To configure Input Leap to use `libei` for Wayland support, add the
+following USE declarations:
+
+```
+dev-libs/libportal inputcapture
+x11-misc/input-leap libei
+```
+
+Note that `inputcapture` is NOT a USE flag on the main Gentoo ebuild. So
+if you haven't unmasked this overlay's version of `libportal`, you will
+receive an error when trying to install Input Leap.