Commit graph

274 commits

Author SHA1 Message Date
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
Yamashita, Yuu
f14a4ef8e5 Merge pull request #54 from apbarrero/alternative_install
Installation instructions for any installation directory.
2013-08-28 00:18:45 -07:00
Antonio Perez Barrero
3bf50856ce Installation instructions for any installation directory.
Updated README.md contents so that installation instructions cover
not only the common case for installation directory, i.e. `~/.pyenv`
but any other at the user's choice.
2013-08-28 08:33:18 +02:00
Stephen Davis
704548336a Fix spelling error 2013-08-27 15:27:57 -04:00
Aaron Stone
1cc75362d6 Clarify the search precedence for .ruby-version files.
Closes #432 [ci skip]
2013-08-07 22:37:21 +02:00
Yamashita Yuu
106e4cae90 Homebrew homepage location changed 2013-08-06 22:57:45 +09:00
Chun-wei Kuo
cc6c45d7fb Fix formatting in the Homebrew section of README 2013-08-01 18:01:38 +08:00
Almog Kurtser
c7208bf1ff Homebrew homepage location changed 2013-07-25 00:02:05 +03:00
Yamashita Yuu
b473f7a271 add CHANGELOG.md 2013-06-13 20:51:17 +09:00
Yamashita Yuu
b726ace943 update README about Homebrew 2013-06-13 20:04:37 +09:00
Marc Huffnagle
5130b41f5b suggest cloning rbenv via https instead of git:// 2013-06-07 19:25:29 +02:00
Yamashita Yuu
3ff0785fe7 prepare README and install.sh for pyenv-version-ext 2013-06-01 15:26:41 +09:00
keitaoouchi
907ddb614d Support new versions(2.7.4, 3.2.5, 3.3.2). 2013-05-16 23:24:21 +09:00
f440
bb2d058167 Support 2.7.4, 3.2.4, 3.3.1 2013-04-07 12:40:12 +09:00
OZAWA Tsuyoshi
0eb1520707 Update README.md 2013-03-08 15:26:15 +09:00
Mislav Marohnić
bb6bccb782 tests galore 2013-03-07 15:07:32 -05:00
Yamashita Yuu
606346761f s/python-virtualenv/pyenv-virtualenv/g in README.md 2013-03-06 12:48:13 +09:00
Yamashita Yuu
0259b6adfb update copyright year 2013-02-23 19:06:58 +09:00
Yamashita Yuu
dbb1fb5a06 release 0.2.0 2013-02-18 12:39:35 +09:00
Yamashita Yuu
be53bb8951 update README 2013-02-06 22:08:16 +09:00
Carlos Rodriguez
14ff078b85 Removed double 'at' from README 2013-01-04 15:14:36 -08:00
Mislav Marohnić
093809eac6 spellcheck 2013-01-04 23:17:52 +01:00
Sam Stephenson
c56f72794e Fix ruby-local-exec wiki page link in the changelog 2013-01-04 12:40:20 -06:00
Sam Stephenson
9375e99f92 rbenv 0.4.0 2013-01-04 12:27:26 -06:00
Sam Stephenson
b66eeaf2f7 Link up the "Why choose rbenv?" wiki page 2013-01-04 12:25:00 -06:00
Mislav Marohnić
c6855e01a9 zshenv -> zshrc. update Ubuntu/zsh installation notices 2013-01-04 17:58:38 +01:00
Sam Stephenson
41cfa5f3d0 Link to the binstubs wiki page 2013-01-04 09:19:18 -06:00
Sam Stephenson
308aa42b67 Rewrite "How It Works" with @trevorturk 2013-01-03 21:18:05 -06:00
Sam Stephenson
5174d14d5c It's all about the apps 2013-01-03 12:49:03 -06:00
Sam Stephenson
6fe338e563 New tagline 2013-01-03 12:40:54 -06:00
Sam Stephenson
266d896871 Prioritize rbenv local over rbenv global and rbenv shell 2013-01-03 10:40:28 -06:00
Sam Stephenson
7e85ae7bd2 "Usage" -> "Command Reference" 2013-01-03 10:25:31 -06:00
Sam Stephenson
9a284a3da4 Update the uninstallation section 2013-01-03 10:20:52 -06:00
Sam Stephenson
871f0e26df Tone down the RVM incompatibility notice 2013-01-03 10:09:22 -06:00
Sam Stephenson
e56885f4c9 "binary" -> "executable" 2013-01-03 10:06:12 -06:00
Sam Stephenson
149f4b4607 "per-project" -> "application-specific" 2013-01-03 10:00:10 -06:00
Sam Stephenson
80750f730f Merge pull request #302 from sstephenson/ruby-version
Support for .ruby-version files
2013-01-03 07:32:02 -08:00
Jeremy Kemper
253f6ee1d9 -information in readme pitch 2013-01-02 19:01:47 -07:00
Jeremy Kemper
bac149e824 Riff on the readme pitch 2013-01-02 19:00:04 -07:00
Sam Stephenson
3ec34448fa Rewrite the readme pitch 2013-01-02 18:56:33 -06:00
Sam Stephenson
377b176260 Document .ruby-version 2012-12-31 09:58:28 -06:00
Oscar Del Ben
c3fe192243 use ruby-build
Fixes #294
2012-12-20 16:56:56 +01:00
Mislav Marohnić
349236c932 tweak docs & add syntax highlighting to instructions 2012-12-12 23:46:10 +01:00
Joe Atzberger
0a9e2baef1 fix documentation about manually compiling Ruby
./configure doesn't exist by default in repo: use autoconf to create it.
2012-12-12 23:10:18 +01:00
Mislav Marohnić
da562ad74c replace build system with generated table of contents
Gets rid of `doc/README.mdtoc` and its build script. Since GitHub.com
renders anchors for each heading, all we have to do is put a simple
table of contents into `README.md` itself, and everything will get
linked up nicely.

Pros of this approach:
* We don't have to point out to people not to edit `README.md` anymore
* We don't have to run the build script each time README gets edited

Cons of this change:
* The "chapter" numbers are lost. They were silly anyway.

`doc/mdtoc` renders a Markdown table of contents for a Markdown file.
`doc/filter-toc` filters that down to only headings after ToC.
This script can be used to easily insert ToC into the current document
when editing `README.md` with, e.g., Vim:

    :read !doc/filter-toc %
2012-12-12 23:06:44 +01:00
Javier Candeira
7f1aefa09b fix install instructions for ubuntu (using version 12.04, but should work for all versions) 2012-12-12 16:15:28 +11:00
Guillermo Iguaran
2a347226df Merge pull request #225 from dentarg/master
Fixed broken link to RVM in documentation
2012-12-11 13:19:53 -08:00
Ryan Bigg
962452d6d1 Merge pull request #188 from tundramonkey/master
Added in short note on Uninstalling Rubies under new 2.4 section in README
2012-12-11 13:13:44 -08:00
Guillermo Iguaran
fc3a634e22 Update README: use last version of jruby in examples 2012-12-11 15:56:03 -05:00
Guillermo Iguaran
01a9141780 Merge pull request #278 from mattdbridges/master
Just trying to keep the README.md up to date with Ruby versions
2012-12-11 12:54:11 -08:00
Matt Bridges
b745a51f30 Update README.md
Changing Ruby versions references to latest versions to keep somewhat up-to-date.
2012-11-17 01:57:23 -06:00
Yamashita Yuu
7509b9fadf update feature list in README 2012-11-06 13:17:04 +09:00
Yamashita Yuu
b520475b22 release 0.1.2 2012-10-23 15:24:41 +09:00
Yamashita Yuu
d73e945329 "rbx-1.2.4" is a variant of rubies, not a python 2012-10-19 22:14:24 +09:00
Yamashita Yuu
779aacbf07 I am not Sam. 2012-10-19 22:12:31 +09:00
Yamashita Yuu
e8ad78f837 add pyenv push and pyenv pop to manage version stack 2012-10-03 12:19:42 +09:00
Yamashita Yuu
aede700619 update README 2012-10-03 11:31:10 +09:00
Yamashita Yuu
42079cf3fb fix typo in README 2012-09-28 20:17:26 +09:00
Yamashita Yuu
13122ca9bf fixed to read multiple versions from PYENV_VERSION environment variable 2012-09-07 19:16:42 +09:00
Yamashita Yuu
d08fcc522e release 0.1.1 2012-09-03 19:40:30 +09:00
Yamashita Yuu
e66ca60340 updated screenshot 2012-08-31 21:05:18 +09:00
Yamashita Yuu
71e5cd962e updated README 2012-08-31 20:59:24 +09:00
Yamashita Yuu
880ea61dd8 0.1.1git 2012-08-31 15:59:36 +09:00
Yamashita Yuu
2457419b4a created new project.
modified rbenv source for Python and renamed to pyenv.
2012-08-31 15:30:20 +09:00
Eric
183c780698 Installation Step 1 is a one liner
Not a big change, just thought it's always good to make it easier for a beginner
2012-08-28 12:37:15 -06:00
Patrik Ragnarsson
406c8e0303 Fixed broken link to RVM in documentation 2012-05-12 22:38:56 +02:00
Daryl Manning
5e57ab95ce Changed doc/README.mdtoc and built README.md and changed nomenclature to 'ruby versions' as requested. 2012-02-09 16:20:53 +11:00
Daryl Manning
9b286ecbfd And better codify the rbenv command just for good measure. 2012-02-03 17:54:07 +11:00
Daryl Manning
b7e9569ccb Embrassing typo in the anchor link neme != name. 2012-02-03 17:52:09 +11:00
Daryl Manning
e922131422 Added in section 2.4 on uninstalling rubies from .rbenv/versions to the README. 2012-02-03 17:48:20 +11:00
Jussi Virtanen
34813ef32c Fix typos in documentation 2012-01-29 11:35:01 +02:00
Sam Stephenson
b10bdb1e78 rbenv 0.3.0 2011-12-25 21:32:48 -05:00
Sam Stephenson
5052a4161c Update readme screenshot to use global instead of set-default (fixes #165) 2011-12-25 16:53:59 -05:00
Sam Stephenson
4cc6665d0a Zsh users need to modify ~/.zshenv, not ~/.zshrc 2011-11-14 12:52:10 -06:00
Sam Stephenson
01a0ad0b69 rbenv 0.2.1 2011-10-01 12:26:19 -05:00
Sam Stephenson
2bbe2099eb Missing word 2011-10-01 12:20:58 -05:00
Sam Stephenson
fb0ec9e157 Be explicit about ~ 2011-10-01 11:05:31 -05:00
Eric Skogen
ddd4db1b05 Fix command to modify ~/.bash_profile in user's home directory (~/, instead of in-place) 2011-09-30 21:54:09 -05:00
Sam Stephenson
7a929b8a84 Indentation 2011-09-28 13:41:10 -05:00
Sam Stephenson
2cd12e3fa6 rbenv 0.2.0 2011-09-28 13:38:03 -05:00
Sam Stephenson
4965a1d1f7 Style 2011-09-28 13:35:17 -05:00
Sam Stephenson
dc1f583903 "Zsh" is the canonical capitalization 2011-09-28 13:29:37 -05:00
Sam Stephenson
500c6de37c fill-region 2011-09-28 13:27:42 -05:00
Joshua Peek
88e59647ae Installation edits 2011-09-28 13:05:29 -05:00
Sam Stephenson
53d45707ca Add Homebrew to the readme 2011-09-28 12:19:47 -05:00
Sam Stephenson
828051e651 Move intro line above the fold 2011-09-28 12:19:46 -05:00
Sam Stephenson
4712db8edd Add version history 2011-09-28 12:01:44 -05:00
Sam Stephenson
7ba843c585 Add upgrade instructions 2011-09-28 11:20:36 -05:00
Sam Stephenson
09d912895f Fix markdown indentation 2011-09-28 10:51:09 -05:00