From 4b94a18a53e81d7f652813098016d18ee3094607 Mon Sep 17 00:00:00 2001
From: dgb <107956274+eatyourbaby@users.noreply.github.com>
Date: Fri, 30 Aug 2024 02:11:05 +0000
Subject: [PATCH] docs: add newuidmap req (#253)

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 66eedca..1347fe3 100644
--- a/README.md
+++ b/README.md
@@ -93,6 +93,26 @@ git:(mistress) | ▶
 - stop using symlinks!!!
 - no more dev config files when writing code
 
+## requirements
+
+boxxy requires `newuidmap` to function, which is not included by default in all
+distributions. To install:
+
+Alpine:
+```sh
+$ apk add shadow-uidmap
+```
+
+Debian / Ubuntu:
+```sh
+$ apt install uidmap
+```
+
+RHEL / Fedora:
+```sh
+$ yum install shadow-utils
+```
+
 ## configuration
 
 The boxxy configuration file lives in `~/.config/boxxy/boxxy.yaml`. If none