Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
terlar committed Dec 14, 2014
1 parent 04fd4a1 commit dad20bd
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ make install
Add the following to the `~/.config/fish/config.fish` file:

```sh
. /usr/local/share/fry/fry.fish
source /usr/local/share/fry/fry.fish
```

### Arch Linux
Expand All @@ -22,7 +22,7 @@ Add the following to the `~/.config/fish/config.fish` file:
To install, use your favorite AUR helper (`yaourt`, `aura`, etc.).

```sh
$ yaourt -S fry
yaourt -S fry
```

### OS X
Expand All @@ -44,7 +44,7 @@ By default `fry` will look for rubies in `~/.rubies`. This can be configured as
### Install (with ruby-install or ruby-build)
If you have [ruby-install](https://github.com/postmodern/ruby-install) or
[ruby-build](https://github.com/sstephenson/ruby-build) installed, `fry` provides a wrapper
with autocompletion and building to the correct destination.
with auto-completion and building to the correct destination.
To install rubies this way, run the following command:

```sh
Expand All @@ -70,6 +70,17 @@ fry config path
fry config path /opt/rubies
```

#### Prepend path

This option determines if your ruby path should be prepended or not. However it will never be at the end of your `PATH` since we are using `fish_user_paths` which is prepended to `PATH`. However if you have specified other paths inside your `fish_user_paths` then those will have higher priority. To change this behavior you can toggle this. The default behavior is append.

```sh
# To prepend to the fish_user_paths
fry config prepend on
# To append to the fish_user_paths
fry config prepend off
```

### Auto-Switch

If you want `fry` to look for a [.ruby-version](https://gist.github.com/fnichol/1912050) file and
Expand All @@ -94,9 +105,13 @@ When you have a `.ruby-version` file in your home directory this will be
used used by default. If you want it to pickup the custom ruby-version
per project you have to create a `.praxconfig` in your home directory or
for pow, you need to create a `.powenv` inside every project folder.
With the following content:

Run the following commands:
```sh
export PATH="$(fish -c 'fry current --path'):$PATH"
# If you have auto-switch, it will use whatever is specified in your .ruby-version
fry env > ~/.praxconfig
# Specify a specific ruby to run
fry env rbx-2.2.6 > ~/ruby_project/.praxenv
```

### Installer
Expand All @@ -107,6 +122,8 @@ through this option. There are currently support for `ruby-install` and
some other tool.

```sh
# To list available installer wrappers
fry installers
# To see the installer used
fry config installer
# To set the desired installer
Expand Down

0 comments on commit dad20bd

Please sign in to comment.