add gnused warning

Quantco · Jan 28, 2024 · 961a48c · 961a48c
1 parent 50971ee
commit 961a48c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 This is a template for our pre-commit mirrors.
 
+> [!WARNING]  
+> This template expects `sed` in your $PATH to be GNU sed. If you are on macOS, you can ensure this by running inside a conda environment with `sed` installed.
+
 To create a new mirror, you can run the following command
 
 ```bash