branch: elpa/exec-path-from-shell
commit 54ea2f9c3c81d18b96e4d33c4c547e02eee420dc
Author: Steve Purcell <[email protected]>
Commit: GitHub <[email protected]>
Make clear that bash and zsh are particularly supported
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index 616449cb97..822d502b63 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,9 @@ variables of interest, then copying them into the Emacs
environment.
Compatibility
-------------
+If the path printed by evaluating `(getenv "SHELL")` in Emacs points at `bash`
+or `zsh`, this should work fine.
+
At a minimum, this package assumes that your shell is at least UNIX-y: if
`(getenv "SHELL")` evaluates to something like `".../cmdproxy.exe"`, this
package probably isn't for you.