From 3a330186fa9b8ef6207d8180413e37c70a24ecda Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Fri, 7 Feb 2020 12:29:49 -0500 Subject: [PATCH 1/5] Add directions to install prerequisites. Clarify Linux .bashrc additions. Add Windows Subsystem for Linux specifics. --- CONTRIBUTING.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4836ce..138e805 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,10 +56,26 @@ eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)" ``` -For Linux (or on the Mac, if you don't want to use `brew`) you can use -[pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) to -install the necessary tools. When you are finished you will need to -add the same two lines above to your profile. +For Linux, Windows Subsystem for Linux (WSL), or on the Mac (if you don't want +to use `brew`) you can use [pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) +to install the necessary tools. Before running this ensure that you have installed +the prerequisites for your platform according to the [`pyenv` wiki page](https://github.com/pyenv/pyenv/wiki/common-build-problems) +. + +On WSL you should treat your platform as whatever Linux distribution you've +chosen to install. + +Once you have installed `pyenv` you will need to add the following lines to your +``.bashrc`: + +```bash +export PATH="$PATH:$HOME/.pyenv/bin" +eval "$(pyenv init -)" +eval "$(pyenv virtualenv-init -)" +``` + +You will need to reload your shell for these changes to take effect so you can +begin to use `pyenv`. For a list of Python versions that are already installed and ready to use with `pyenv`, use the command `pyenv versions`. To see a list of From 9d5904348d4e25ec596ad96de598d6372d05080d Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Fri, 7 Feb 2020 12:53:02 -0500 Subject: [PATCH 2/5] Fix double backtick (`) breaking format. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 138e805..13d0d2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,7 +66,7 @@ On WSL you should treat your platform as whatever Linux distribution you've chosen to install. Once you have installed `pyenv` you will need to add the following lines to your -``.bashrc`: +`.bashrc`: ```bash export PATH="$PATH:$HOME/.pyenv/bin" From b3dae0134aa9c55cd991c6e92df347e8ccbb0611 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Fri, 7 Feb 2020 14:29:23 -0500 Subject: [PATCH 3/5] Remove an errant space before a period ending a sentence Also clean up line breaking, since these changes will likely be backported to skeleton-generic. --- CONTRIBUTING.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13d0d2f..3bb7a04 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,17 +56,19 @@ eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)" ``` -For Linux, Windows Subsystem for Linux (WSL), or on the Mac (if you don't want -to use `brew`) you can use [pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) -to install the necessary tools. Before running this ensure that you have installed -the prerequisites for your platform according to the [`pyenv` wiki page](https://github.com/pyenv/pyenv/wiki/common-build-problems) -. +For Linux, Windows Subsystem for Linux (WSL), or on the Mac (if you +don't want to use `brew`) you can use +[pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) to +install the necessary tools. Before running this ensure that you have +installed the prerequisites for your platform according to the +[`pyenv` wiki +page](https://github.com/pyenv/pyenv/wiki/common-build-problems). -On WSL you should treat your platform as whatever Linux distribution you've -chosen to install. +On WSL you should treat your platform as whatever Linux distribution +you've chosen to install. -Once you have installed `pyenv` you will need to add the following lines to your -`.bashrc`: +Once you have installed `pyenv` you will need to add the following +lines to your `.bashrc`: ```bash export PATH="$PATH:$HOME/.pyenv/bin" @@ -74,8 +76,8 @@ eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)" ``` -You will need to reload your shell for these changes to take effect so you can -begin to use `pyenv`. +You will need to reload your shell for these changes to take effect so +you can begin to use `pyenv`. For a list of Python versions that are already installed and ready to use with `pyenv`, use the command `pyenv versions`. To see a list of From 08e7502eb8a92af7e4c2812dae5c3c4942dc2f80 Mon Sep 17 00:00:00 2001 From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com> Date: Fri, 7 Feb 2020 15:16:41 -0500 Subject: [PATCH 4/5] Add line covering if a user is using a shell other than bash. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bb7a04..c99caea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,6 +76,9 @@ eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)" ``` +If you are using a shell other than `bash` you should follow the instructions +that the `pyenv-installer` script outputs. + You will need to reload your shell for these changes to take effect so you can begin to use `pyenv`. From a7f33f8737ac1ece8ce0788a7f33577d48e99859 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Fri, 7 Feb 2020 16:30:37 -0500 Subject: [PATCH 5/5] Clean up line breakage --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c99caea..6a01cc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,8 +76,8 @@ eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)" ``` -If you are using a shell other than `bash` you should follow the instructions -that the `pyenv-installer` script outputs. +If you are using a shell other than `bash` you should follow the +instructions that the `pyenv-installer` script outputs. You will need to reload your shell for these changes to take effect so you can begin to use `pyenv`.