Merge pull request #23 from thriveth/thriveth-virtualenv-workaround

Update README.md

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
index 016f56d6d38b..c6b9eae3d5ae 100644
--- a/README.md
+++ b/README.md
@@ -23,3 +23,24 @@ cp nvim-wrapper /usr/bin/nvim-wrapper
 cp neovim.desktop /usr/share/applications/neovim.desktop
 cp neovim.svg /usr/share/icons/neovim.svg
 ~~~
+
+### Caveats when using running from virtual environments
+
+Some users have experienced trouble running nvim-wrapper when inside a virtual environment created by e.g. virtualenv, conda or similar.
+One workaround is to point the nvim-wrapper script directly to the right (system) python3 executable, i.e. change: 
+
+~~~
+#! /usr/bin/env python3
+~~~
+
+into:
+
+~~~
+#! /usr/bin/python3
+~~~
+
+After this, make sure the neovim python package is installed from the correct package manager, e.g. in Ubuntu:
+
+~~~
+/usr/bin/pip3 install --user neovim
+~~~