Skip to content

Commit

Permalink
Make some modifications to improve documentation (#121)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeloopzz authored Jan 8, 2025
1 parent 84db73d commit f227f21
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,25 @@ This plugin introduces a new linemode that prefixes file names with a file icon
![image](screenshot.png)

## Prerequisites
This plugin uses glyphs from a patched NERDfont. So in order for this plugin to work you need to
install a NERDfont and set it as the default font for your terminal.

I personally use the Source Code Pro patched NERDfont(this is also the font displayed in the
screenshot), this and other NERDfonts and the install instructions for these fonts can be found in
the following repository: https://github.com/ryanoasis/nerd-fonts
This plugin uses glyphs from a patched NERDfont. So in order for this plugin to work you need to install a NERDfont and set it as the default font for your terminal.

I personally use the Source Code Pro patched NERDfont(this is also the font displayed in the screenshot), this and other NERDfonts and the install instructions for these fonts can be found in the [following repository](https://github.com/ryanoasis/nerd-fonts)

## Install instructions

Ranger has added support for loading directories in the plugins folder which makes it easier to install and keep plugins updated.

To install, just clone the repo into the plugins folder:

```bash
git clone https://github.com/alexanderjeurissen/ranger_devicons ~/.config/ranger/plugins/ranger_devicons
```

Then execute the following `echo "default_linemode devicons" >> $HOME/.config/ranger/rc.conf` (or wherever your `rc.conf` is located).

## Configuration

This plugin can be configured by setting environment variables (e.g. in your
`~/.profile`). Currently, only one option is available:

Expand Down

0 comments on commit f227f21

Please sign in to comment.