<commit_before># VimDevicons – Add Icons to Your Plugins

<h1 align="center">
	<img src="https://github.com/ryanoasis/vim-devicons/wiki/screenshots/v0.8.x/branding-logo.png" alt="vim-devicons">
</h1>

<h1 align="center">
	<img src="https://github.com/ryanoasis/vim-devicons/wiki/screenshots/v0.8.x/overall-screenshot.png" alt="vim-devicons overall screenshot" />
</h1>

[NERDTree] | [vim-airline] | [CtrlP] | [powerline] | [unite] | [lightline.vim]
| [vim-startify] | [vimfiler] | [flagship]

[![GitHub version][img-version-badge]][badge-version] [![Join the chat at https://gitter.im/ryanoasis/vim-devicons][img-gitter-badge]][badge-gitter] [![Flattr this git repo][img-flattr-badge]][badge-flattr]

## Quick Links

| **[Screenshots](#screenshots)**| **[API](#api)** | **[Fonts ➶][patched-fonts]** | **[Patcher ➶][nerd-fonts]** |
|--------------------------------|-----------------|------------------------------|-----------------------------|
| [![screenshots][img-visual-toc-screenshots]](#screenshots) | [![api][img-visual-toc-api]](#api) | [![patcher-logo-small][img-visual-toc-patched-fonts]][patched-fonts] | [![patcher-logo-small][img-visual-toc-fonts-patcher]][nerd-fonts] |

## Table of Contents

[Quick Setup (TL;DR)](#quick-setup)

[Installation](#installation)

[Usage](#usage)

[Screenshots](#screenshots)

[Features](#features)

[Extra Configuration](#extra-configuration)

[Character Mappings](#character-mappings)

[Lightline Setup](#lightline-setup)

[Powerline Setup](#powerline-setup)

[Vim Plugin Installation](#installation)

[Methods](#public-methods)

[API](#api)

[Todo](#todo)

[FAQ / Troubleshooting](#faq--troubleshooting)

[Contributing](#contributing)

[Rationale](#rationale)

[Inspiration and special thanks](#inspiration-and-special-thanks)

[License](#license)


<a name="quick-setup"></a>
## Quick Setup (TL;DR)

1. Download and install a patched **[nerd-font](https://github.com/ryanoasis/nerd-fonts)** (or patch your own) _[(» More details... «)](https://github.com/ryanoasis/nerd-fonts)_

2. Install the plugin per your usual method _[(» More details... «)](#installation)_

3. Set font  _[(» More details... «)](#install-step2)_
  * a. **vim**: Set your terminal emulator font
  * b. **gvim**: Set `guifont` in your `vimrc`

<a name="installation"></a>
## Installation

This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:

### Step 1

#### [Pathogen](https://github.com/tpope/vim-pathogen)
  *  `git clone https://github.com/ryanoasis/vim-devicons ~/.vim/bundle/vim-devicons`

#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
  * Add to vimrc:

      ```vim
      NeoBundle 'ryanoasis/vim-devicons'
      ```
  * And install it:

      ```vim
      :so ~/.vimrc
      :NeoBundleInstall
      ```

#### [Vundle](https://github.com/gmarik/vundle)
  * Add to vimrc:

       ```vim
       Plugin 'ryanoasis/vim-devicons'
       ```
  * And install it:

       ```vim
       :so ~/.vimrc
       :PluginInstall`
       ```

#### Manual
  *  copy all of the files into your `~/.vim` directory

<a name="install-step2"></a>
### Step 2

Add the following to your .vimrc or .gvimrc:

##### Encoding **must** be set to UTF-8 for the glyphs to show
  ```vim
  set encoding=utf8
  ```
##### For Powerline symbols to show in airline the following needs to be set
  ```vim
  let g:airline_powerline_fonts = 1
  ```
#### vimrc examples
* [Sample Windows vimrc configuration 1](https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.8.x/.vimrc-windows-1)
* [Sample Linux vimrc configuration 1](https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.8.x/.vimrc-linux-1)

The _ONLY_ other configuration needed should be setting the font vim uses to a
  patched font.

Already patched fonts and the font patcher script are provided at:
[nerd-fonts]

It works without configuration *ONLY* when used with a patched font provided in
the separate repository above. Install the font and add it to your `vimrc` or
`gvimrc`:

**Linux**
 ```vim
 set guifont=<FONT_NAME> <FONT_SIZE>
 ```

```vim
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
```

**OS X and Windows**
```vim
set guifont=<FONT_NAME>:h<FONT_SIZE>
```

```vim
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types:h11
```

## Usage

After installing the patched font and setting the vim font just open or look at any of the supported plugins you have installed ([NERDTree][nerdtree], [airline][vim-airline], [powerline], [unite], [lightline.vim], [vimfiler], or [flagship]).

* _NOTE:_ if you don't have `guifont` set and are not running gvim you will need to set the terminal font.

* _NOTE:_ for support of these plugins: [NERDTree], [vim-airline], [CtrlP], [powerline], [unite], [vimfiler], [flagship] you **must** configure vim to load those plugins **_before_** vim-devicons loads.

* _NOTE:_ for better [nerdtree-git-plugin] support, you _should_ configure vim to load nerdtree-git-plugin **_before_** vim-devicons loads.

## Extra Configuration

* by default you should not *NEED* to configure anything to get the basics working<commit_msg>updated OS X --> macOS<commit_after># VimDevicons – Add Icons to Your Plugins

<h1 align="center">
	<img src="https://github.com/ryanoasis/vim-devicons/wiki/screenshots/v0.8.x/branding-logo.png" alt="vim-devicons">
</h1>

<h1 align="center">
	<img src="https://github.com/ryanoasis/vim-devicons/wiki/screenshots/v0.8.x/overall-screenshot.png" alt="vim-devicons overall screenshot" />
</h1>

[NERDTree] | [vim-airline] | [CtrlP] | [powerline] | [unite] | [lightline.vim]
| [vim-startify] | [vimfiler] | [flagship]

[![GitHub version][img-version-badge]][badge-version] [![Join the chat at https://gitter.im/ryanoasis/vim-devicons][img-gitter-badge]][badge-gitter] [![Flattr this git repo][img-flattr-badge]][badge-flattr]

## Quick Links

| **[Screenshots](#screenshots)**| **[API](#api)** | **[Fonts ➶][patched-fonts]** | **[Patcher ➶][nerd-fonts]** |
|--------------------------------|-----------------|------------------------------|-----------------------------|
| [![screenshots][img-visual-toc-screenshots]](#screenshots) | [![api][img-visual-toc-api]](#api) | [![patcher-logo-small][img-visual-toc-patched-fonts]][patched-fonts] | [![patcher-logo-small][img-visual-toc-fonts-patcher]][nerd-fonts] |

## Table of Contents

[Quick Setup (TL;DR)](#quick-setup)

[Installation](#installation)

[Usage](#usage)

[Screenshots](#screenshots)

[Features](#features)

[Extra Configuration](#extra-configuration)

[Character Mappings](#character-mappings)

[Lightline Setup](#lightline-setup)

[Powerline Setup](#powerline-setup)

[Vim Plugin Installation](#installation)

[Methods](#public-methods)

[API](#api)

[Todo](#todo)

[FAQ / Troubleshooting](#faq--troubleshooting)

[Contributing](#contributing)

[Rationale](#rationale)

[Inspiration and special thanks](#inspiration-and-special-thanks)

[License](#license)


<a name="quick-setup"></a>
## Quick Setup (TL;DR)

1. Download and install a patched **[nerd-font](https://github.com/ryanoasis/nerd-fonts)** (or patch your own) _[(» More details... «)](https://github.com/ryanoasis/nerd-fonts)_

2. Install the plugin per your usual method _[(» More details... «)](#installation)_

3. Set font  _[(» More details... «)](#install-step2)_
  * a. **vim**: Set your terminal emulator font
  * b. **gvim**: Set `guifont` in your `vimrc`

<a name="installation"></a>
## Installation

This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:

### Step 1

#### [Pathogen](https://github.com/tpope/vim-pathogen)
  *  `git clone https://github.com/ryanoasis/vim-devicons ~/.vim/bundle/vim-devicons`

#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
  * Add to vimrc:

      ```vim
      NeoBundle 'ryanoasis/vim-devicons'
      ```
  * And install it:

      ```vim
      :so ~/.vimrc
      :NeoBundleInstall
      ```

#### [Vundle](https://github.com/gmarik/vundle)
  * Add to vimrc:

       ```vim
       Plugin 'ryanoasis/vim-devicons'
       ```
  * And install it:

       ```vim
       :so ~/.vimrc
       :PluginInstall`
       ```

#### Manual
  *  copy all of the files into your `~/.vim` directory

<a name="install-step2"></a>
### Step 2

Add the following to your .vimrc or .gvimrc:

##### Encoding **must** be set to UTF-8 for the glyphs to show
  ```vim
  set encoding=utf8
  ```
##### For Powerline symbols to show in airline the following needs to be set
  ```vim
  let g:airline_powerline_fonts = 1
  ```
#### vimrc examples
* [Sample Windows vimrc configuration 1](https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.8.x/.vimrc-windows-1)
* [Sample Linux vimrc configuration 1](https://github.com/ryanoasis/vim-devicons/wiki/samples/v0.8.x/.vimrc-linux-1)

The _ONLY_ other configuration needed should be setting the font vim uses to a
  patched font.

Already patched fonts and the font patcher script are provided at:
[nerd-fonts]

It works without configuration *ONLY* when used with a patched font provided in
the separate repository above. Install the font and add it to your `vimrc` or
`gvimrc`:

**Linux**
 ```vim
 set guifont=<FONT_NAME> <FONT_SIZE>
 ```

```vim
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
```

**macOS and Windows**
```vim
set guifont=<FONT_NAME>:h<FONT_SIZE>
```

```vim
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types:h11
```

## Usage

After installing the patched font and setting the vim font just open or look at any of the supported plugins you have installed ([NERDTree][nerdtree], [airline][vim-airline], [powerline], [unite], [lightline.vim], [vimfiler], or [flagship]).

* _NOTE:_ if you don't have `guifont` set and are not running gvim you will need to set the terminal font.

* _NOTE:_ for support of these plugins: [NERDTree], [vim-airline], [CtrlP], [powerline], [unite], [vimfiler], [flagship] you **must** configure vim to load those plugins **_before_** vim-devicons loads.

* _NOTE:_ for better [nerdtree-git-plugin] support, you _should_ configure vim to load nerdtree-git-plugin **_before_** vim-devicons loads.

## Extra Configuration

* by default you should not *NEED* to configure anything to get the basics working
{'fraction_non_alphanumeric': 0.18637332816437294, 'fraction_numerical': 0.005815080441946114, 'mean_word_length': 3.956292026897214, 'pattern_counts': {'":': 0, '<': 35, '<?xml version=': 0, '>': 36, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3562150', 'n_tokens_mistral': 3798, 'n_tokens_neox': 3473, 'n_words': 931}