Skip to content

Commit 3f6d654

Browse files
authored
Merge pull request #31 from cisagov/improvements/add_wsl_instructions
Cleanup Linux instructions and add WSL references to CONTRIBUTING.md
2 parents a8e35d0 + 5327516 commit 3f6d654

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,31 @@ eval "$(pyenv init -)"
5656
eval "$(pyenv virtualenv-init -)"
5757
```
5858

59-
For Linux (or on the Mac, if you don't want to use `brew`) you can use
59+
For Linux, Windows Subsystem for Linux (WSL), or on the Mac (if you
60+
don't want to use `brew`) you can use
6061
[pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) to
61-
install the necessary tools. When you are finished you will need to
62-
add the same two lines above to your profile.
62+
install the necessary tools. Before running this ensure that you have
63+
installed the prerequisites for your platform according to the
64+
[`pyenv` wiki
65+
page](https://github.com/pyenv/pyenv/wiki/common-build-problems).
66+
67+
On WSL you should treat your platform as whatever Linux distribution
68+
you've chosen to install.
69+
70+
Once you have installed `pyenv` you will need to add the following
71+
lines to your `.bashrc`:
72+
73+
```bash
74+
export PATH="$PATH:$HOME/.pyenv/bin"
75+
eval "$(pyenv init -)"
76+
eval "$(pyenv virtualenv-init -)"
77+
```
78+
79+
If you are using a shell other than `bash` you should follow the
80+
instructions that the `pyenv-installer` script outputs.
81+
82+
You will need to reload your shell for these changes to take effect so
83+
you can begin to use `pyenv`.
6384

6485
For a list of Python versions that are already installed and ready to
6586
use with `pyenv`, use the command `pyenv versions`. To see a list of

0 commit comments

Comments
 (0)