github/pyenv
1
0
Fork 0
mirror of https://github.com/pyenv/pyenv.git synced 2024-11-21 20:47:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs(README): removed $ in front of CLI commands (#1620)

Browse source 
This makes it easier to copy and paste commands from the README.
This commit is contained in:
Glen Winters 2020-05-21 11:29:21 -05:00 committed by GitHub
parent 2c32a6be15
commit 31f1732fa2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -171,8 +171,8 @@ For macOS:
1. Consider installing with [Homebrew](#homebrew-on-macos) 1. Consider installing with [Homebrew](#homebrew-on-macos)
```sh ```sh
$ brew update brew update
$ brew install pyenv brew install pyenv
``` ```
2. Then follow the rest of the post-installation steps under [Basic GitHub Checkout](https://github.com/pyenv/pyenv#basic-github-checkout), starting with #3 ("Add `pyenv init` to your shell to enable shims and autocompletion"). 2. Then follow the rest of the post-installation steps under [Basic GitHub Checkout](https://github.com/pyenv/pyenv#basic-github-checkout), starting with #3 ("Add `pyenv init` to your shell to enable shims and autocompletion").
@ -192,7 +192,7 @@ easy to fork and contribute any changes back upstream.
1. **Check out pyenv where you want it installed.** 1. **Check out pyenv where you want it installed.**
A good place to choose is `$HOME/.pyenv` (but you can install it somewhere else). A good place to choose is `$HOME/.pyenv` (but you can install it somewhere else).
$ git clone https://github.com/pyenv/pyenv.git ~/.pyenv git clone https://github.com/pyenv/pyenv.git ~/.pyenv
2. **Define environment variable `PYENV_ROOT`** to point to the path where 2. **Define environment variable `PYENV_ROOT`** to point to the path where
@ -201,26 +201,26 @@ easy to fork and contribute any changes back upstream.
- For **bash**: - For **bash**:
~~~ bash ~~~ bash
$ echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bash_profile echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bash_profile
$ echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bash_profile echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bash_profile
~~~ ~~~
- For **Ubuntu Desktop**: - For **Ubuntu Desktop**:
~~~ bash ~~~ bash
$ echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
$ echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
~~~ ~~~
- For **Zsh**: - For **Zsh**:
~~~ zsh ~~~ zsh
$ echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc
$ echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
~~~ ~~~
- For **Fish shell**: - For **Fish shell**:
~~~ fish ~~~ fish
$ set -Ux PYENV_ROOT $HOME/.pyenv set -Ux PYENV_ROOT $HOME/.pyenv
$ set -Ux fish_user_paths $PYENV_ROOT/bin $fish_user_paths set -Ux fish_user_paths $PYENV_ROOT/bin $fish_user_paths
~~~ ~~~
- **Proxy note**: If you use a proxy, export `http_proxy` and `HTTPS_PROXY` too. - **Proxy note**: If you use a proxy, export `http_proxy` and `HTTPS_PROXY` too.
@ -229,7 +229,7 @@ easy to fork and contribute any changes back upstream.
Please make sure `eval "$(pyenv init -)"` is placed toward the end of the shell Please make sure `eval "$(pyenv init -)"` is placed toward the end of the shell
configuration file since it manipulates `PATH` during the initialization. configuration file since it manipulates `PATH` during the initialization.
```sh ```sh
$ echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' >> ~/.bash_profile echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' >> ~/.bash_profile
``` ```
- **Zsh note**: Modify your `~/.zshrc` file instead of `~/.bash_profile`. - **Zsh note**: Modify your `~/.zshrc` file instead of `~/.bash_profile`.
- **fish note**: Use `pyenv init - | source` instead of `eval (pyenv init -)`. - **fish note**: Use `pyenv init - | source` instead of `eval (pyenv init -)`.
@ -244,7 +244,7 @@ easy to fork and contribute any changes back upstream.
4. **Restart your shell so the path changes take effect.** 4. **Restart your shell so the path changes take effect.**
You can now begin using pyenv. You can now begin using pyenv.
```sh ```sh
$ exec "$SHELL" exec "$SHELL"
``` ```
5. [**Install Python build dependencies**](https://github.com/pyenv/pyenv/wiki#suggested-build-environment) before attempting to install a new Python version. 5. [**Install Python build dependencies**](https://github.com/pyenv/pyenv/wiki#suggested-build-environment) before attempting to install a new Python version.
@ -252,7 +252,7 @@ easy to fork and contribute any changes back upstream.
6. **Install Python versions into `$(pyenv root)/versions`.** 6. **Install Python versions into `$(pyenv root)/versions`.**
For example, to download and install Python 2.7.8, run: For example, to download and install Python 2.7.8, run:
```sh ```sh
$ pyenv install 2.7.8 pyenv install 2.7.8
``` ```
**NOTE:** If you need to pass configure option to build, please use **NOTE:** If you need to pass configure option to build, please use
```CONFIGURE_OPTS``` environment variable. ```CONFIGURE_OPTS``` environment variable.
@ -269,7 +269,7 @@ easy to fork and contribute any changes back upstream.
If you've installed pyenv using homebrew, upgrade using: If you've installed pyenv using homebrew, upgrade using:
```sh ```sh
$ brew upgrade pyenv brew upgrade pyenv
``` ```
If you've installed pyenv using the instructions above, you can If you've installed pyenv using the instructions above, you can
@ -278,18 +278,17 @@ upgrade your installation at any time using git.
To upgrade to the latest development version of pyenv, use `git pull`: To upgrade to the latest development version of pyenv, use `git pull`:
```sh ```sh
$ cd $(pyenv root) cd $(pyenv root)
$ git pull git pull
``` ```
To upgrade to a specific release of pyenv, check out the corresponding tag: To upgrade to a specific release of pyenv, check out the corresponding tag:
```sh ```sh
$ cd $(pyenv root) cd $(pyenv root)
$ git fetch git fetch
$ git tag git tag
v0.1.0 git checkout v0.1.0
$ git checkout v0.1.0
``` ```
### Uninstalling pyenv ### Uninstalling pyenv
@ -394,8 +393,8 @@ and easy to understand, even if you're not a shell hacker.
Tests are executed using [Bats](https://github.com/bats-core/bats-core): Tests are executed using [Bats](https://github.com/bats-core/bats-core):
$ bats test bats test
$ bats/test/<file>.bats bats/test/<file>.bats
Please feel free to submit pull requests and file bugs on the [issue Please feel free to submit pull requests and file bugs on the [issue
tracker](https://github.com/pyenv/pyenv/issues). tracker](https://github.com/pyenv/pyenv/issues).