github/pyenv
1
0
Fork 0
mirror of https://github.com/pyenv/pyenv.git synced 2025-05-04 23:11:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

README.md: Minor formatting

Browse source
This commit is contained in:
Zearin 2014-03-20 09:17:53 -04:00
parent 0933c40179
commit 650c9a3d6e
1 changed files with 30 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -35,19 +35,19 @@ This project was forked from [rbenv](https://github.com/sstephenson/rbenv) and
## Table of Contents ## Table of Contents
* [How It Works](#how-it-works) * **[How It Works](#how-it-works)**
* [Understanding PATH](#understanding-path) * [Understanding PATH](#understanding-path)
* [Understanding Shims](#understanding-shims) * [Understanding Shims](#understanding-shims)
* [Choosing the Python Version](#choosing-the-python-version) * [Choosing the Python Version](#choosing-the-python-version)
* [Locating the Python Installation](#locating-the-python-installation) * [Locating the Python Installation](#locating-the-python-installation)
* [Installation](#installation) * **[Installation](#installation)**
* [Basic GitHub Checkout](#basic-github-checkout) * [Basic GitHub Checkout](#basic-github-checkout)
* [Upgrading](#upgrading) * [Upgrading](#upgrading)
* [Homebrew on Mac OS X](#homebrew-on-mac-os-x) * [Homebrew on Mac OS X](#homebrew-on-mac-os-x)
* [Neckbeard Configuration](#neckbeard-configuration) * [Neckbeard Configuration](#neckbeard-configuration)
* [Uninstalling Python Versions](#uninstalling-python-versions) * [Uninstalling Python Versions](#uninstalling-python-versions)
* [Command Reference](#command-reference) * **[Command Reference](#command-reference)**
* [Development](#development) * **[Development](#development)**
* [Version History](#version-history) * [Version History](#version-history)
* [License](#license) * [License](#license)
@ -142,8 +142,7 @@ As far as pyenv is concerned, version names are simply the directories in
## Installation ## Installation
If you're on Mac OS X, consider If you're on Mac OS X, consider [installing with Homebrew](#homebrew-on-mac-os-x).
[installing with Homebrew](#homebrew-on-mac-os-x).
### The automatic installer ### The automatic installer
@ -157,16 +156,16 @@ https://github.com/yyuu/pyenv-installer
This will get you going with the latest version of pyenv and make it This will get you going with the latest version of pyenv and make it
easy to fork and contribute any changes back upstream. easy to fork and contribute any changes back upstream.
1. **Check out pyenv where you want it installed.** A good place to choose is 1. **Check out pyenv where you want it installed.**
`$HOME/.pyenv` but you may install it somewhere else. A good place to choose is `$HOME/.pyenv` (but you can install it somewhere else).
$ cd $ cd
$ git clone git://github.com/yyuu/pyenv.git .pyenv $ git clone git://github.com/yyuu/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
pyenv repo is cloned and add `$PYENV_ROOT/bin` to your `$PATH` for access pyenv repo is cloned and add `$PYENV_ROOT/bin` to your `$PATH` for access
to the `pyenv` command-line utility. to the `pyenv` command-line utility.
$ 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
@ -181,24 +180,26 @@ to the `pyenv` command-line utility.
**Zsh note**: Modify your `~/.zshenv` file instead of `~/.bash_profile`. **Zsh note**: Modify your `~/.zshenv` file instead of `~/.bash_profile`.
**Ubuntu note**: Modify your `~/.bashrc` file instead of `~/.bash_profile`. **Ubuntu note**: Modify your `~/.bashrc` file instead of `~/.bash_profile`.
4. **Restart your shell so the path changes take effect.** You can now 4. **Restart your shell so the path changes take effect.**
begin using pyenv. You can now begin using pyenv.
$ exec $SHELL $ exec $SHELL
5. **Install Python versions into `$PYENV_ROOT/versions`.** For example, to 5. **Install Python versions into `$PYENV_ROOT/versions`.**
install Python 2.7.6, download and unpack the source, then run: For example, to install Python 2.7.6, download and unpack the source, then run:
$ pyenv install 2.7.6 $ pyenv install 2.7.6
**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.
**NOTE** If you are having trouble installing a python version please visit the wiki page about [Common Build Problems](https://github.com/yyuu/pyenv/wiki/Common-build-problems) **NOTE:** If you are having trouble installing a python version,
please visit the wiki page about
[Common Build Problems](https://github.com/yyuu/pyenv/wiki/Common-build-problems)
6. **Rebuild the shim binaries.** You should do this any time you install 6. **Rebuild the shim binaries.**
a new Python binary. (Examples: installing a new Python version, You should do this any time you install a new Python binary.
or installing a package that provides a binary.) (Examples: installing a new Python version, or installing a package that provides a binary.)
$ pyenv rehash $ pyenv rehash
@ -213,8 +214,7 @@ To upgrade to the latest development version of pyenv, use `git pull`:
$ cd ~/.pyenv $ cd ~/.pyenv
$ git pull $ git pull
To upgrade to a specific release of pyenv, check out the corresponding To upgrade to a specific release of pyenv, check out the corresponding tag:
tag:
$ cd ~/.pyenv $ cd ~/.pyenv
$ git fetch $ git fetch
@ -225,13 +225,12 @@ tag:
### Homebrew on Mac OS X ### Homebrew on Mac OS X
You can also install pyenv using the You can also install pyenv using the [Homebrew](http://brew.sh)
[Homebrew](http://brew.sh) package manager on Mac OS X. package manager for Mac OS X.
$ brew update
$ brew install pyenv
~~~
$ brew update
$ brew install pyenv
~~~
To upgrade pyenv in the future, just use `upgrade` instead of `install`. To upgrade pyenv in the future, just use `upgrade` instead of `install`.
@ -292,12 +291,11 @@ See [COMMANDS.md](COMMANDS.md).
## Development ## Development
The pyenv source code is [hosted on The pyenv source code is [hosted on GitHub](https://github.com/yyuu/pyenv).
GitHub](https://github.com/yyuu/pyenv). It's clean, modular, It's clean, modular, and easy to understand--even if you're not a shell hacker.
and easy to understand, even if you're not a shell hacker.
Please feel free to submit pull requests and file bugs on the [issue Please feel free to submit Pull Requests and report bugs on the
tracker](https://github.com/yyuu/pyenv/issues). [issue tracker](https://github.com/yyuu/pyenv/issues).
### Version History ### Version History