Commit graph

142 commits

Author SHA1 Message Date
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
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
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
Ryan Bigg
749f21e482 Install a more recent version of Ruby in README instructions 2013-09-09 10:41:04 +10:00
Aaron Stone
1cc75362d6 Clarify the search precedence for .ruby-version files.
Closes #432 [ci skip]
2013-08-07 22:37:21 +02:00
Almog Kurtser
c7208bf1ff Homebrew homepage location changed 2013-07-25 00:02:05 +03:00
Marc Huffnagle
5130b41f5b suggest cloning rbenv via https instead of git:// 2013-06-07 19:25:29 +02:00
Mislav Marohnić
bb6bccb782 tests galore 2013-03-07 15:07:32 -05: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
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
Sam Stephenson
ada26ab92e Document rbenv which and rbenv whence 2011-09-28 10:48:04 -05:00
Sam Stephenson
a3d3005859 Document rbenv shell 2011-09-28 10:13:28 -05:00
Javier Julio
c6c6ebaf40 Updating command sample to "rbenv install", no dash 2011-09-20 10:59:27 -04:00
Javier Julio
919fc872c8 Using simpler rbenv-install command in ruby-build section 2011-09-17 17:38:09 -04:00
Sam Stephenson
5be66da9f4 Rename rbenv-default to rbenv-global 2011-08-18 14:35:00 -05:00
Sam Stephenson
20425c297f Avoid passive voice 2011-08-18 12:57:36 -05:00
Sam Stephenson
174e101799 Merge remote-tracking branch 'gma/drop-set-prefix' into drop-set-prefix 2011-08-18 12:50:06 -05:00
Joshua Peek
01ddcd7f1d Merge pull request #24 from chrisledet/master
Use $HOME when specifying installation prefix
2011-08-14 11:24:36 -07:00
Graham Ashton
1ed231cb21 Report default or local version.
If no argument is passed to the default or local sub commands, report
the currently configured version.
2011-08-13 08:26:54 +01:00
Graham Ashton
7a0cde9a4e Remove set- prefix from local and default commands. 2011-08-13 08:26:54 +01:00
Sam Stephenson
8685c899ba Let's not bruise any egos 2011-08-12 10:51:58 -05:00
Chris Ledet
b4c100e149 use HOME variable when specifying the install dir 2011-08-11 22:19:33 -04:00
Sam Stephenson
dfe9889327 Fix ruby-build link 2011-08-11 14:41:24 -05:00
Sam Stephenson
192dc23998 Try a different image url 2011-08-11 14:29:52 -05:00
Sam Stephenson
6c468d6166 Don't highlight the anchors 2011-08-11 14:26:53 -05:00
Sam Stephenson
bfa71017ae Add TOC header 2011-08-11 14:25:08 -05:00
Sam Stephenson
066d63c0df Use mdtoc for the readme 2011-08-11 14:21:15 -05:00
Sam Stephenson
7c8da88df6 Add a screenshot 2011-08-11 14:12:01 -05:00
Sam Stephenson
06bf3a351a Add a note about rvm compatibility 2011-08-11 13:28:02 -05:00
Sam Stephenson
f8f49fd565 Document rbenv-rehash 2011-08-11 13:25:54 -05:00
Sam Stephenson
77964fb83e Simplify 2011-08-11 13:25:47 -05:00
Sam Stephenson
b4a91648eb Hard-wrap 2011-08-11 13:11:37 -05:00
Sam Stephenson
e8d010f33c Fix italics 2011-08-11 12:53:20 -05:00
Sam Stephenson
a804b5eb21 Add LICENSE and README.md 2011-08-11 12:51:35 -05:00