Commit graph

262 commits

Author SHA1 Message Date
Anton Petrov
f53aa3e64e
Update README.md
corrected fish shell command
2021-01-15 08:02:25 +03:00
Jan Bronicki
b61536e9ee more general installation readme instructions 2021-01-13 19:36:39 +01:00
Almenon
db939bbcfc
Put prerequisite for installation before install (#1750)
This prevents people from jumping the gun and trying to install a python version right after brew install.
2020-12-10 19:50:14 -05:00
Ville Skyttä
5221c4aeea README: note optional bash extension build
Borrowed from rbenv.
2020-12-05 18:19:26 +02:00
Edward D'Souza
86497f72c2
Fix homebrew link in README. 2020-06-10 19:31:58 -04:00
Glen Winters
31f1732fa2
docs(README): removed $ in front of CLI commands (#1620)
This makes it easier to copy and paste commands from the README.
2020-05-21 12:29:21 -04:00
Marshall Zobel
098227f26c
improve the flow of macOS installation instructions (#1599) 2020-05-01 14:07:31 -04:00
Swaroop Hegde
3e0f5e798c
Fixes missing double quote in README #1582 (#1583)
Bash example had a missing quote for setting PYENV_ROOT path
2020-04-10 13:00:13 -04:00
Alexander Popov
0f2d659732
Update instructions for installation in README (#1580)
Describe more clearly for different shells.
2020-04-09 09:03:55 -04:00
Edwin Shin
2a0d576681
Update README.md (#1555)
Update the bats link to https://github.com/bats-core/bats-core (which is what pyenv is actually using on [Travis](https://github.com/pyenv/pyenv/blob/master/.travis.yml#L35))
2020-04-02 15:24:48 -04:00
Kareem Francis
84f3f77a39
Update README: highlight brew post-install steps (#1543)
I skimmed past the requires post-installation steps for Homebrew when walking though the README. 
Anecdotally, other devs noted the same issue.
2020-02-28 18:52:41 -05:00
Josh Friend
4500a33c73
Modify zshrc instead of zshenv
https://github.com/pyenv/pyenv/issues/1400#issuecomment-551371058

Closes #846, #1400, #1447, #1449
2020-01-10 12:59:46 -05:00
Tim Gates
32663fb8a4
Fix simple typo: abovementioned -> above
Closes #1485
2019-12-17 17:29:37 +11:00
Saahil Hamayun
eacde87acf Grammatical corrections 2019-12-01 20:00:17 -05:00
Josh Friend
7dd50144d5
Link windows users to pyenv-win
see #62
2019-04-28 20:21:47 -04:00
Ratul R
6fa07b32e5
Minor formatting changes
Adding a list to the notes of point #2 in Basic GitHub Checkout steps.
2019-03-22 11:16:38 +05:30
Kenta Sato
336cc885cf
Add a note for fish shell users (close #1203) 2019-01-11 17:21:17 +09:00
Alan Yee
cd7c8af487
Update README.md
Replace OS X with macOS
2018-10-29 22:02:21 -07:00
Kyle Altendorf
c6e3f95f67
Add readme step for installing build deps per wiki 2018-08-28 10:25:51 -04:00
raimon
694b551935 Fix dead links in ToC (#1121) 2018-03-15 15:42:52 -04:00
Hugo Locurcio
7ca1923a44
Use Markdown image markup in README
This also fixes the aspect ratio of the image being incorrect.
2018-02-22 15:43:44 +01:00
Charles Reid
59050aa093 Fixing image of terminal output to use carbon (cleaner and easier-to-read colors) 2018-02-08 16:08:24 -08:00
CIARANA
f6384fe8d4 Update pyenv init line in README.md 2017-09-09 00:39:02 +09:00
cia-rana
839c9e5c76 Update pyenv init line in README.md 2017-09-08 02:07:47 +09:00
cia-rana
2a2cbea951 Change [ to [[ and move it into eval 2017-09-08 01:23:21 +09:00
CIARANA
bc58ab54f8 Change ~/.pyenv to $PYENV_ROOT 2017-09-07 22:36:14 +09:00
CIARANA
6485409a55 Update pyenv init line in README.md
Update `pyenv init` line in README.md in case ```pyenv``` is not found.
2017-09-07 20:31:02 +09:00
diggzhang
7c9ebc2727 Fix readme.md 2017-08-05 14:11:30 +08:00
Ryan Moore
e83168655c Update README.md 2017-06-24 00:50:54 +00:00
Jamie Webb
27a7466f15 Update link to pyenv shell documentation in README 2017-05-02 16:52:53 +01:00
Matt Bachmann
0a69dbd818 Remove duplicate heading
Link was pointing to this heading. It seemed incorrect
2017-04-29 07:14:46 -04:00
Doug Harris
cf38195541 Updated docs to reflect homebrew change. (#867)
* Updated docs to reflect homebrew change.

The instructions previously mentioned in this file were removed from the Homebrew caveats since
they weren't specific to homebrew. See discussion in [this homebrew issue](https://github.com/Homebrew/homebrew-core/pull/11209)

* Added link to specific section of readme
2017-03-21 16:00:37 -04:00
Samuel Villamonte
d12120a4bf Change curl to proxy note 2017-03-12 09:53:15 -05:00
Samuel Villamonte
b1dd4a8130 Agh spaces 2017-03-12 09:50:35 -05:00
Samuel Villamonte
f1a22c104c Mention http_proxy and HTTPS_PROXY in README.md 2017-03-12 09:45:32 -05:00
Yamashita, Yuu
8ce9928819 Update Travi CI build status link target 2017-03-06 04:42:15 +00:00
Yamashita, Yuu
98a879bdb0 Migrate project URL from https://github.com/yyuu to https://github.com/pyenv 2017-03-06 04:14:12 +00:00
Jakub Wilk
3a4c7cf200 Fix typos 2017-03-02 00:20:59 +01:00
SUZUKI Masaya
c1af5ab0a9 Fix the file path. 2017-02-10 10:04:35 +09:00
massongit
4cef3d74ac Fix file the path and file name of README.md 2017-02-06 22:26:13 +09:00
Ori Peleg
fa80772142 README: multiple versions in .python-version
Document that multiple versions in `.python-version` work similarly to the command line.
2017-01-02 16:18:38 +02:00
Peter Dave Hello
3531ad06b2 Syntax highlight in README.md 2017-01-01 18:39:20 +08:00
Yamashita, Yuu
0256ff06e8 Add mention to pyenv-virtualenv in README (#662) 2016-12-27 00:51:29 +00:00
Fábio C. Barrionuevo da Luz
fc7ceb4176 document how to accelerate the download with aria2 2016-12-16 14:08:44 -03:00
Ville Skyttä
22ab0f8b2f Like Ubuntu, Fedora users should modify ~/.bashrc too 2016-10-11 22:39:25 +03:00
Ville Skyttä
e04f2720b4 Make Ubuntu notes stand out better; add linebreak after zsh ones
Line break accomplished by two trailing spaces on the zsh lines.
2016-10-11 22:38:19 +03:00
Yamashita, Yuu
6bd7927333 Basically we don't have to run rehash explicitly anymore (fixes #553) 2016-03-11 01:02:01 +00:00
Daniel Hahler
03ece82197 Merge remote-tracking branch 'rbenv/master'
Using `git merge rbenv/master -s recursive -X rename-threshold=5%`.

Conflicts:
	README.md
	bin/python-local-exec
	libexec/pyenv
	libexec/pyenv-help
	test/--version.bats
2015-12-14 13:47:11 +01:00
Chulki Lee
df4c16ecb4 update urls to rbenv 2015-12-07 11:03:07 -08:00
ReadmeCritic
43abe13db9 Update README URLs based on HTTP redirects 2015-11-27 19:12:54 -08:00
ReadmeCritic
f85c41b14f Update README URLs based on HTTP redirects 2015-11-25 10:08:28 -08:00
Yamashita, Yuu
8da3749648 Merge remote-tracking branch 'rbenv/master' into rbenv-20151121 2015-11-21 04:21:14 +00:00
Britta
6e3dd80f15 Readme fixes: tiny copyedits
Removing an extra comma in "There are some systems, where the", and adding another "the" to "toward the end of shell configuration file".
2015-11-18 16:50:03 -08:00
Britta
d5a5cd1aae Readme fixes: clarifying Homebrew instructions
Adding a tip for how to view the Homebrew package caveats again if you skipped reading them.

Directing readers to additional next steps after installing pyenv via Homebrew.
2015-11-18 16:48:57 -08:00
Britta
195942f22e Changing "neckbeard" to "advanced"
Many advanced users who enjoy reading detailed documentation may not really think of themselves as "neckbeards", even in a jokey way, so naming this section with a simple, familiar (and easy-to-translate!) name may encourage more people to read it. :)
2015-11-17 16:51:03 -08:00
Britta
daaa1aab6d Readme fixes: correcting errors
Correcting instructions for installing Python versions (removing "download and unpack the source").

Fixing links to #pyenv-shell, #pyenv-local, and #pyenv-global - linking them to the appropriate sections of the COMMANDS.md page.
2015-11-17 16:35:35 -08:00
Yamashita, Yuu
cb65df8bec Specify branch for build status 2015-11-04 12:14:10 +00:00
Fengyuan Chen
53bc95314c add proxy usage note 2015-09-24 21:46:34 +08:00
Yamashita, Yuu
e034c80388 Update Python versions in sample image 2015-09-23 00:29:49 +09:00
The Gitter Badger
10ab381fb6 Add Gitter badge 2015-09-21 02:43:40 +00:00
Nik Nyby
8e276a009e fix typo in readme 2015-06-22 18:54:03 -04:00
Mislav Marohnić
46fbc5414a Provide uninstall instructions in the README 2015-06-09 23:31:01 +02:00
Nathan Henrie
17c153b1c1 Details on multiple Python2 and Python3 versions.
Add detail regarding activating multiple Python2 and Python3 versions simultaneously.
2015-04-17 16:59:04 -06:00
Yamashita Yuu
71c9ff565b Added note about where to place pyenv init - in shell configuration file (#313) 2015-04-15 22:41:09 +09:00
Mislav Marohnić
7ad01b2b48 Document rbenv environment variables
Closes #699, fixes #666 [ci skip]
2015-03-13 01:14:24 -07:00
Lorenzo Manacorda
c54fa3731f Remove dead links to Version history and License
Cfr. #688
2015-02-26 11:39:31 +01:00
Mislav Marohnić
4d0c289287 Merge pull request #688 from sstephenson/readme-no-history
Remove history, license information from README
2015-02-25 11:50:39 +13:00
Adam Prescott
9ae8ba8a29 Update README to make rbenv version consistent with previous versions output
The `rbenv versions` info highlights 1.9.3-p327 as the current version, and
making `rbenv version` sample output match that helps make it clearer.
2015-02-16 10:56:38 -05:00
Grégoire Pineau
70c6d3f67e [README] Updated link to bundler.io 2015-02-16 04:03:08 +01:00
Mislav Marohnić
b155380a06 Remove license information from README
The license information is already present in the LICENSE file.
2015-01-29 02:10:28 -08:00
Mislav Marohnić
cd60df52af Remove rbenv version history from README
We won't maintain it anymore. Instead, the changelogs can be obtained
from the project's Releases page: https://github.com/sstephenson/rbenv/releases
2015-01-29 02:09:05 -08:00
cloudlite
dbd50e7bd9 Update README.md - clone through https instead of git
git:// protocol is blocked by a lot of servers, https works fine.
2015-01-19 20:51:18 -05:00
Jeremy Brudvik
7535efe031 Use better image for Travis build status 2015-01-13 19:53:29 -08:00
Arnav Kumar
f28b3ee123 Update README.md
Made it consistent with the rbenv documentation by having the cloning step in the installation clone it directly into the home directory.
2014-12-18 11:41:25 +08:00
Yamashita Yuu
ee4182321e Update python versions in README 2014-11-05 09:17:05 -08:00
Yamashita, Yuu
661a2b29d3 Merge pull request #236 from blueyed/doc-mention-pyenv-pip-rehash
README: mention https://github.com/yyuu/pyenv-pip-rehash
2014-11-05 09:14:35 -08:00
Yamashita, Yuu
8c503c6e75 Merge pull request #237 from blueyed/doc-recent-python-versions
doc: use recommended python versions
2014-11-05 09:13:55 -08:00
Konstantin Tretyakov
96c0362b53 Warn about #264 in the README 2014-11-04 18:54:19 +02:00
Daniel Hahler
04ce9bcd5c doc: use recommended python versions 2014-09-11 12:56:56 +02:00
Daniel Hahler
4cf93df059 README: mention https://github.com/yyuu/pyenv-pip-rehash 2014-09-11 12:55:39 +02:00
Daniel Hahler
8595df4e18 minor: remove trailing whitespace 2014-09-03 02:51:22 +02:00
Daniel Hahler
200adac02f doc: note about using multiple versions
Add a note about how to activate/use multiple versions to the main
README, to the "Choosing the Python Version" section.
2014-09-03 02:47:57 +02:00
Zearin
5c6a812b86 README.md: Add dividers between major sections 2014-03-20 09:19:11 -04:00
Zearin
650c9a3d6e README.md: Minor formatting 2014-03-20 09:17:53 -04:00
Zearin
0933c40179 Move command reference to COMMANDS.md 2014-03-20 09:13:15 -04:00
Tony
d1f78c2716 README.md: Minor edits and formatting 2014-03-19 15:00:54 -04:00
Ehtesh Choudhury
7ed908bad1 Addendum for pyenv install usage
This gives users an idea of which versions of python are available. Other version managers ([nvm](https://github.com/creationix/nvm), [rvm](https://rvm.io/rubies/list), etc) tell users how to list available versions as well.
2014-03-03 17:11:23 -05:00
Ezequiel Bertti
6ee219b9c7 add automatic install by pyenv-installer 2014-02-21 00:57:42 -03:00
Yamashita Yuu
20e5404248 Update README about usage with multiple versions (#92) 2014-01-29 18:00:56 +09:00
Yamashita Yuu
56c58e2778 Modernize python versions in README 2014-01-29 17:54:01 +09:00
Yamashita Yuu
34087d03ec Add build status badge 2014-01-08 21:47:36 +09:00
Jonathan Dean
09ec276a85 Change 'Advanced Configuration' reference to 'How rbenv hooks into your shell' 2013-12-14 16:38:25 -05:00
Jonathan Dean
590b19a1b1 Remove Neckbeard reference in favor of Advanced 2013-12-13 14:06:44 -05:00
Omer Katz
80b8508dbc Added a link about the common build problems. 2013-11-20 18:16:03 +02:00
Gunes
ff23666d56 typo: remove "v" (version prefix) 2013-10-03 22:18:43 +02:00
Mislav Marohnić
16c3e0ddac tweak installation instructions
Provide an `rbenv install` example and explanation lower down, so that
both folk that are following git install and Homebrew install will
finish at the same section and learn how to use ruby-build.

Also remove step 6 of manual install process: `rbenv rehash`. It's
unnecessary at that point, even if they already did `rbenv install`
(which rehashes automatically).

Fixes #455, closes #456
2013-10-03 20:52:13 +02:00
Mislav Marohnić
0d216c2d82 remove rbenv install example; clarify manual compile
It can be confusing if people mistake the example as instructions to
install ruby-build with.
2013-10-03 20:17:10 +02:00
Mislav Marohnić
a1fb5b1153 better Ubuntu Desktop installation instructions
Don't suggest that they add to their `.profile` anymore because:

1. They would have to restart the desktop session for their change to be
   reflected, or source the file manually;
2. An error in `.profile` may prevent logging in;
3. The `rbenv()` shell function and shell completions won't be available
   in Terminal since it doesn't start bash in login mode by default.

Therefore, suggest that they use `.bashrc` instead. This will be
immediately reflected in a new Terminal tab. If bash is started in login
mode somehow, the default `.profile` is set up to source `.bashrc` anyway.

Also, don't suggest restarting the shell environment with
`exec $SHELL -l`, since we don't know what was the original mode that
their shell was started in. (OS X Terminal.app will be login mode,
Ubuntu Terminal has non-login mode by default.) Mode can be checked with:

* bash: `shopt -q login_shell`
* zsh: `[[ $options[login] = "on" ]]`

But since this is gnarly, let's just avoid it altogether and go the
easy route.

Closes #305, fixes #373, reverts #286
2013-10-03 20:07:22 +02:00
Ricardo Lüders
5c41dc3901 Ubuntu environment configuration 2013-09-12 21:07:40 -03:00
Ryan Bigg
749f21e482 Install a more recent version of Ruby in README instructions 2013-09-09 10:41:04 +10:00