From cc4fb183e504420bedef8650eafb17b3ffa200c2 Mon Sep 17 00:00:00 2001 From: William Johnston Date: Fri, 13 Oct 2017 07:01:48 -0500 Subject: [PATCH] Clarify readme for case where other gems are overriding --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d8a4145..e947152 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,24 @@ And then execute: ## Usage - # Capfile - require 'capistrano/rbenv' +```ruby +# Capfile +require 'capistrano/rbenv' - # config/deploy.rb - set :rbenv_type, :user # or :system, depends on your rbenv setup - set :rbenv_ruby, '2.4.2' +# config/deploy.rb +set :rbenv_type, :user # or :system, depends on your rbenv setup +set :rbenv_ruby, '2.4.2' - # in case you want to set ruby version from the file: - # set :rbenv_ruby, File.read('.ruby-version').strip +# in case you want to set ruby version from the file: +# set :rbenv_ruby, File.read('.ruby-version').strip - set :rbenv_prefix, "RBENV_ROOT=#{fetch(:rbenv_path)} RBENV_VERSION=#{fetch(:rbenv_ruby)} #{fetch(:rbenv_path)}/bin/rbenv exec" - set :rbenv_map_bins, %w{rake gem bundle ruby rails} - set :rbenv_roles, :all # default value +# The following are defaults. You should #append to them in case other gems +# have also overriden them. +#set :rbenv_prefix, "RBENV_ROOT=#{fetch(:rbenv_path)} RBENV_VERSION=#{fetch(:rbenv_ruby)} #{fetch(:rbenv_path)}/bin/rbenv exec" +#set :rbenv_map_bins, %w{rake gem bundle ruby rails} +#set :rbenv_roles, :all +``` If your rbenv is located in some custom path, you can use `rbenv_custom_path` to set it.