1
0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-11-19 16:39:20 +02:00
nerd-fonts/readme.md
Ryan L McIntyre c165ecf1a2 Update readme.md
hr line tweak
2015-07-05 12:35:59 -04:00

8.5 KiB

nerd fonts

[![GitHub version](https://badge.fury.io/gh/ryanoasis%2Ffont-nerd-icons.svg)](http://badge.fury.io/gh/ryanoasis%2Ffont-nerd-icons) =========================================

Table of Contents

Glyph Sets

Set 1: Seti-UI + Custom

  • Seti-UI / icomoon plus misc custom glyphs image

Set 2: devicons

Set 3: Pomicons

Set 4: powerline-extra-symbols

  • Work In Progress... :) image

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

Patched Fonts

Font Name em size status
3270 Plus Nerd File Types 1000 [TEST]
Anonymice Powerline Plus Nerd File Types 2048 [TEST]
Aurulent Sans Mono Plus Nerd File Types 1000 [TEST]
Bitstream Vera Sans Mono Plus Nerd File Types 2048 [TEST]
DejaVu Sans Mono Plus Nerd File Types 2048 [TEST]
Droid Sans Mono for Powerline Plus Nerd File Types 2048 [TEST]
Fira Mono for Powerline Plus Nerd File Types 1000 [TEST]
Heavy Data Mono for Powerline Plus Nerd File Types 2048 [TEST]
Inconsolata for Powerline Plus Nerd File Types 1000 [TEST]
Lekton for Powerline Plus Nerd File Types 1000 [TEST]
Literation Mono for Powerline Plus Nerd File Types 2048 [TEST]
Meslo for Powerline Plus Nerd File Types 2048 [TEST]
Monofur for Powerline Plus Nerd File Types 2400 [TEST]
M+ (MPlus) for Powerline Plus Nerd File Types 1000 [TEST]
ProFont (Windows tweaked) for Powerline Plus Nerd File Types 1200 [TEST]
ProFont (x11) for Powerline Plus Nerd File Types 1000 [FAIL]
ProggyCleanTT Plus Nerd File Types 2048 [TEST]
Sauce Code Powerline Plus Nerd File Types 1000 [TEST]
Terminess for Powerline Plus Nerd File Types 1000 [FAIL]
Ubuntu Mono derivative Powerline Plus Nerd File Types 1000 [TEST]
Ubuntu Mono Plus Nerd File Types 1000 [TEST]
  • Variations include:
  • extra glyphs that are double or single (monospaced) width
  • Pomiconsgabrielelana-pomicons
  • Windows Compatible (WIP)

Permutations

  • Over 350 unique permutations/variations of patched fonts:
  • 44 font variations (just counting otf and ttf)
  • 8 permutations (1 no flags, 3 flagged options)
  • Calculated Permutations (8 * 44) = 352
  • Permutations for each font are any combination of (plus no flags option):
    • Monospaced extra glyphs
    • Windows Compatible
    • Pomicons

Font Install Script

  • Linux & Mac OS X

    ./install.sh

Examples

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

Font Patcher

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

  • requires: python2, python-fontforge package
  • usage:
./font-patcher PATH_TO_FONT
usage: font-patcher [-h] [-s] [-q] [-w] font

Patches a given font with programming and web development related glyphs
(mainly for vim-webdevicons)

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
  -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)
  --pomicons            Add Pomicon Glyphs
                        (https://github.com/gabrielelana/pomicons)

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

Gotta Patch 'em All Font Patcher!

  • re-patches all fonts in the unpatched directory
  • mostly for Contributor/Dev use only
./gotta-patch-em-all-font-patcher\!.sh

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
  • PragmataPro

Rationale

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

Other

  • previously known as 'nerd-filetype-glyphs-fonts-patcher'

License

see LICENSE