From 1c3c1dd3c0802bf77c0e388ee331d00ceb68cf78 Mon Sep 17 00:00:00 2001
From: Casey Rodarmor <casey@rodarmor.com>
Date: Fri, 14 Jun 2024 22:32:07 -0700
Subject: [PATCH] Add note to readme about quoting paths on Windows (#2166)

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

diff --git a/README.md b/README.md
index d369682..de792ba 100644
--- a/README.md
+++ b/README.md
@@ -3647,6 +3647,17 @@ Node.js `package.json` files:
 export PATH := "./node_modules/.bin:" + env_var('PATH')
 ```
 
+### Paths on Windows
+
+On Windows, functions that return paths will return `\`-separated paths. When
+not using PowerShell or `cmd.exe` these paths should be quoted to prevent the
+`\`s from being intepreted as character escapes:
+
+```just
+ls:
+    echo '{{absolute_path(".")}}'
+```
+
 ### Alternatives and Prior Art
 
 There is no shortage of command runners! Some more or less similar alternatives