nerd-fonts/readme.md

Nerd Fonts is a project that attempts to patch as many developer targeted and/or used fonts as possible. The patch is to specifically add a high number of additional glyphs from popular 'iconic fonts' such as Font Awesome, Devicons, Octicons, and others.

For more high level info see the wiki. Looking for the Vim plugin see vim-devicons ➶.

_{Diagram created using @SankeyMATIC}

Quick Links

---

Fonts	Patcher	Vim Plugin ➶

---

Features

• A FontForge python script to patch any font
• 24 already patched font families
• Over 2,700 unique combinations/variations of patched fonts (more details)
• Over 1,000 glyphs/icons combined (more details)
• A Developer/Contributor provided bash script to re-patch all the fonts

| Unstable file paths warning: To avoid font file references breaking on releases please read |

Table of Contents

• Glyph sets
• Usage
• Patched Fonts List
• Combinations
• Font Installation
• Font Install Script (Linux & Mac OS X)
• Font Patcher
• Gotta Patch 'em All Font Patcher!
• Unstable file paths on master
• Other Good Fonts to Patch
• Motivation
• Other
• License

Glyph Sets

Seti-UI + Custom

Based off of Seti-UI Icomoon with additional custom glyphs added from various sources.

Devicons

An iconic font made for developers, code jedis, ninjas, HTTPsters, evangelists and nerds(sic). / (repo) / (website)

Font Awesome

The iconic font and CSS toolkit. / (repo) / (website)

Octicons

GitHub's icons. / (repo) / (website)

Powerline Extra Symbols

Provides additional Powerline separator glyphs and a column number glyph (CN). / (repo)

Font Linux

Font-linux is an icon font containing logos of popular linux distributions for inclusion in websites. / (repo)

Pomicons

8 symbols for the "Pomodoro Technique"®. / (repo)

Usage

Option A

Install any of the already provided patched fonts

Option B

Use the provided python command line script to generate a patched font from your own font to get the additional new glyphs

See: Font Patcher for usage

• use this option if you do not want to use one of the fonts provided

Patched Fonts

| Font Name | Font Name and Repository | *RFN | EM Size | Status | |---------------------------------------------------------------------------------|------|---------|-------------------| | 3270 Nerd Font | | NO | 1000 | [TEST] | | [Anonymice Nerd Font][p-anonymous-pro] | Anonymous Pro | NO | 2048 | [TEST] | | Aurulent Sans Mono Nerd Font | | NO | 1000 | [TEST] | | Bitstream Vera Sans Mono Nerd Font | | NO | 2048 | [TEST] | | DejaVu Sans Mono Nerd Font | | NO | 2048 | [TEST] | | Droid Sans Mono Nerd Font | | NO | 2048 | [TEST] | | Fantasque Sans Nerd Font | Fantasque Sans | NO | 2048 | [TEST] | | Fura Code Nerd Font | Fira | YES | 1000 | [TEST] | | Fura Mono Nerd Font | Fira | YES | 1000 | [TEST] | | Heavy Data Mono Nerd Font | | NO | 2048 | [TEST] | | Hermut Nerd Font | | NO | 1000 | [TEST] | | Inconsolata Nerd Font | | NO | 1000 | [TEST] | | Iosevka | Iosevka | YES | 1000 | [TEST] | | Knack Nerd Font | Hack | YES | 2048 | #70 | | Lekton Nerd Font | | NO | 1000 | [TEST] | | Literation Mono Nerd Font | Liberation | YES | 2048 | [TEST] | | Meslo Nerd Font | | NO | 2048 | [TEST] | | Monofur Nerd Font | | NO | 2400 | [TEST] | | Monoid Nerd Font | | NO | 1536 | [TEST] | | M+ (MPlus) Nerd Font | | NO | 1000 | [TEST] | | ProFont (Windows tweaked) Nerd Font | | NO | 1200 | [TEST] | | ProFont (x11) Nerd Font | | NO | 1000 | [FAILING] | | ProggyClean Nerd Font | | NO | 2048 | [FAILING] | | Roboto Mono | | NO | 2048 | [FAILING] | | Sauce Code Nerd Font | Source | YES | 1000 | [TEST] | | Terminess Nerd Font | Terminus Font | YES | 1000 | #16 | | Ubuntu Mono derivative Nerd Font | | NO | 1000 | [TEST] | | [Ubuntu Mono Nerd Font][p-ubuntu-mono] | | NO | 1000 | [TEST] |

_{*RFN = Reserved Font Name}

• Variations include:
• extra glyphs that are double or single (monospaced) width
• Font Awesome
• GitHub Octicons
• Font Linux
• Pomicons
• Full Windows Compatibility (WIP)

Combinations

• Over 2,700 unique variations/combinations (Power Set) of patched fonts:
• 77 font variations (just counting otf and ttf)
• 36 combinations (Powerline Extra included by default currently)
• Calculated combinations (36 * 77) = 2,772
• Combinations for each font are any combination of (plus no flags option):
  • Monospaced extra glyphs
  • Windows Compatible
  • Font Awesome
  • GitHub Octicons
  • Font Linux
  • Pomicons

Font Installation

Put any font you would like to use into the ~/.local/share/fonts (Linux) or ~/Library/Fonts/(OS X) folder. For example:

Linux

mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20for%20Powerline%20Nerd%20Font%20Complete.otf

deprecated alternate paths: ~/.fonts

OS X

cd ~/Library/Fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20for%20Powerline%20Nerd%20Font%20Complete.otf

Font Install Script

Installs all of the patched Fonts (Warning: This is a lot of Fonts adding up to a large size)

• Linux & Mac OS X

./install.sh

Examples

./install.sh
All fonts installed to /home/ryan/.fonts

Patching the font of your own choosing for use with the vim-devicons vim plugin:

• requires: python2, python-fontforge package (version 20141231 or later, see the install instructions)
• can alternately be installed on OSX via: brew install fontforge
• Usage:

./font-patcher PATH_TO_FONT

• Alternate usage: Alternately the patcher can be run through the FontForge binary using the script flag:

./fontforge -script font-patcher PATH_TO_FONT

usage: font-patcher [-h] [-v] [-s] [-q] [-w] [--fontawesome] [--fontlinux]
                    [--octicons] [--pomicons] [--powerline] [--powerlineextra]
                    [--careful] [-out [OUTPUTDIR]]
                    font

Patches a given font with programming and web development related glyphs
(mainly for https://github.com/ryanoasis/vim-devicons)

positional arguments:
  font                  The path to the font to be patched (e.g.
                        Inconsolata.otf)

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -s, --use-single-width-glyphs
                        Whether to generate the glyphs as single-width not
                        double-width (default is double-width)
  -q, --quiet, --shutup
                        Do not generate verbose output
  -w, --windows, --limit-font-name-length
                        Limit the internal font name to a maximum of 31
                        characters (for safe Windows compatiblity)
  --fontawesome         Add Font Awesome Glyphs (http://fortawesome.github.io
                        /Font-Awesome)
  --fontlinux           Add Font Linux Glyphs (https://github.com/Lukas-W
                        /font-linux)
  --octicons            Add Octicons Glyphs (https://octicons.github.com)
  --pomicons            Add Pomicon Glyphs
                        (https://github.com/gabrielelana/pomicons)
  --powerline           Add Powerline Glyphs
  --powerlineextra      Add Powerline Glyphs (https://github.com/ryanoasis
                        /powerline-extra-symbols)
  --careful             Do not overwrite existing glyphs if detected
  -out [OUTPUTDIR], --outputdir [OUTPUTDIR]
                        The directory to output the patched font file to

Examples

./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf -s -q
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf --use-single-width-glyphs --quiet
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf -w
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf --windows --quiet
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf --windows --pomicons --quiet
./font-patcher Inconsolata.otf --fontawesome
./font-patcher Inconsolata.otf --fontawesome --octicons --pomicons
./font-patcher Inconsolata.otf

Gotta Patch 'em All Font Patcher!

• re-patches all fonts in the unpatched directory
• mostly for Contributor/Dev use only
• can optionally limit to specific font pattern (second example)

./gotta-patch-em-all-font-patcher\!.sh
./gotta-patch-em-all-font-patcher\!.sh Hermit

Unstable file paths

| Unstable file paths warning |

| Please make sure to reference via the release branch and not the master branch because paths are subject to being improved/changed per release | | For example (paths shorted for demonstation purposes): | | Instead of: https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/DroidSansMono/< font_path >.otf | | Please use: https://github.com/ryanoasis/nerd-fonts/blob/0.7.0/patched-fonts/DroidSansMono/< font_path >.otf |

Other Good Fonts to Patch

• a list of additional good fonts to patch that I cannot provide or share due to the license:
• Input Mono
  • Coming soon with external hosting :)
• PragmataPro

Motivation (Original Rationale)

• Originally created for use with vim-devicons vim plugin to add glyphs (icons) as labels for files based on the filetype extension or entire path

Other

• project/repo previously known as 'nerd-filetype-glyphs-fonts-patcher', 'font-nerd-icons'

License

see LICENSE