From 1593b0e6b069897a02c20e813f122f8f01747276 Mon Sep 17 00:00:00 2001 From: Ben Creasy Date: Tue, 20 Jun 2017 23:44:53 -0700 Subject: [PATCH] Be more explicit about `.python-version` file When I came back to this after a few months - despite setting it up properly previously - I was a bit confused since I'm so used to setting an actual Python version in `.python-version` files. Explain exactly how the file should look. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb69784..ebf138d 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ There are two entries for each virtualenv, and the shorter one is just a symlink Some external tools (e.g. [jedi](https://github.com/davidhalter/jedi)) might require you to `activate` the virtualenv and `conda` environments. -If `eval "$(pyenv virtualenv-init -)"` is configured in your shell, `pyenv-virtualenv` will automatically activate/deactivate virtualenvs on entering/leaving directories which contain a `.python-version` file that lists a valid virtual environment. `.python-version` files denote local Python versions and can be created and deleted with the [`pyenv local`](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-local) command. +If `eval "$(pyenv virtualenv-init -)"` is configured in your shell, `pyenv-virtualenv` will automatically activate/deactivate virtualenvs on entering/leaving directories which contain a `.python-version` file that contains the name of a valid virtual environment as shown in the output of `pyenv virtualenvs` (e.g., `venv34` or `3.4.3/envs/venv34` in example above) . `.python-version` files are used by pyenv to denote local Python versions and can be created and deleted with the [`pyenv local`](https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-local) command. You can also activate and deactivate a pyenv virtualenv manually: