about summary refs log tree commit diff
path: root/users/tazjin/niri-reap
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@tvl.su>2024-10-02T14·11+0300
committerclbot <clbot@tvl.fyi>2024-10-02T14·37+0000
commitde39bb422e2b71809d44020081802929187dbca1 (patch)
tree2af424c2787b5bc9bfe0a7e1847ca464ee2240e2 /users/tazjin/niri-reap
parentcd050400db8decdc08061b7450e50dc72abb58fb (diff)
docs(tazjin/niri-reap): add a simple README r/8750
Change-Id: I53c760115bda3df2f964ac359f4c9e127c9890ad
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12565
Autosubmit: tazjin <tazjin@tvl.su>
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
Diffstat (limited to 'users/tazjin/niri-reap')
-rw-r--r--users/tazjin/niri-reap/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/users/tazjin/niri-reap/README.md b/users/tazjin/niri-reap/README.md
new file mode 100644
index 000000000000..207a087657fa
--- /dev/null
+++ b/users/tazjin/niri-reap/README.md
@@ -0,0 +1,20 @@
+niri-reap
+=========
+
+Tiny, MIT-licensed companion program for [niri](https://github.com/YaLTeR/niri).
+
+I don't use workspaces in my workflow, but when disconnecting an external
+screen, the workspaces that it was displaying are moved to the remaining screen.
+
+This program "reaps" all windows on workspaces except the currently active one,
+and moves them all to the current workspace.
+
+## Usage
+
+If you have the full TVL monorepo, just `mg run //users/tazjin/niri-reap`. There
+is no configuration, and there are no flags.
+
+If you don't have the TVL monorepo and just want `niri-reap`, do this:
+
+1. Get the code: `git clone https://code.tvl.fyi/depot.git:/users/tazjin/niri-reap.git`
+2. Run the code: `cargo run`