2015-08-11 00:33:21 +02:00
< h1 align = "center" >
2016-11-19 17:03:05 +02:00
< img src = "images/nerd-fonts-logo.png" alt = "Nerd Fonts Logo" / >
2015-08-11 00:33:21 +02:00
< / h1 >
2015-11-11 17:23:50 +02:00
2016-11-20 18:36:27 +02:00
[![GitHub release][img-version-badge-with-logo]][repo] [![Gitter][img-gitter-badge]][gitter] [![Windows Logo][w-top]](#patched-fonts) [![macOS (OSX) Logo][m-top]](#patched-fonts) [![Linux Logo][l-top]](#patched-fonts)
2016-11-18 06:46:22 +02:00
2016-11-18 05:44:34 +02:00
2016-10-22 17:40:41 +02:00
**Nerd Fonts** is a project that patches developer targeted fonts with a high number of glyphs (icons). Specifically to add a high number of extra glyphs from popular 'iconic fonts' such as [Font Awesome][font-awesome], [Devicons][vorillaz-devicons], [Octicons][octicons], and [others ](#glyph-sets ).
2016-03-15 15:03:39 +02:00
2016-05-15 20:03:03 +02:00
The following Sankey flow diagram shows the current glyph sets included:
2016-03-15 15:03:39 +02:00
2016-11-19 17:03:05 +02:00
< p align = "center" >
2016-12-15 03:35:45 +02:00
< img src = "https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/custom-sankey-glyphs-combined-diagram.png" alt = "@SankeyMATIC Diagram" / >
2016-11-19 17:03:05 +02:00
< / p >
2016-03-20 19:15:28 +02:00
< sub > _Diagram created using [@SankeyMATIC ](http://sankeymatic.com/ )_</ sub >
## Quick Links
2016-05-15 05:30:32 +02:00
2016-12-23 19:21:36 +02:00
**[Latest Release ➶][latest-release]** | ** [Fonts ](#patched-fonts )** | ** [Patcher ](#font-patcher )** | ** [VimDevIcons ➶][vim-devicons]** | ** [Font Package < br /> Downloads][latest-release]**
|---------------------------------------|-----------------------------|------------------------------|------------------------------------|-----------------------------|
| < p align = "center" > [![fonts-logo-small][ql-1]][latest-release]< / p > | [![fonts-logo-small][ql-2]](#patched-fonts) | [![patcher-logo-small][ql-3]](#font-patcher) | < p align = "center" > [![vim-devicons-logo-small][ql-4]][vim-devicons]< / p > | < p align = "center" > [![fonts-logo-small][ql-5]][latest-release]< / p > |
2015-08-11 00:33:21 +02:00
2016-10-22 18:54:47 +02:00
2016-11-20 18:36:27 +02:00
## Important Notices
2016-11-23 02:13:37 +02:00
* `master` branch file paths are **not** considered stable. [Verify your repository URI references ](#unstable-file-paths )
2016-11-20 18:36:27 +02:00
* cloning this repository is **not** recommended unless you are going to be [contributing to development ](#contributing )
2015-08-11 00:33:21 +02:00
## Table of Contents
2015-09-25 15:53:27 +02:00
2016-11-21 00:20:55 +02:00
[**Installation Options** ](#font-installation )
* [**1 - Install Script** ](#option-1-install-script )
* [**2 - Ad Hoc Curl Download** ](#option-2-ad-hoc-curl-download )
* [**3 - Release Archive Download** ](#option-3-release-archive-download )
* [**4 - Homebrew Fonts (macOS (OS X))** ](#option-4-homebrew-fonts )
2017-01-25 04:33:04 +02:00
* [**5 - Arch User Repository (AUR) (Arch Linux)** ](#option-5-unofficial-arch-user-repository-aur )
* [**6 - Manual** ](#option-6-download-and-install-manually )
* [**7 - Clone Repo** ](#option-7-clone-the-repo )
* [**8 - Patch Your Own Font** ](#option-8-patch-your-own-font )
2016-11-21 00:20:55 +02:00
2016-11-23 02:13:37 +02:00
[**Features** ](#features )
2016-11-21 00:20:55 +02:00
* [**Glyph/Icon sets** ](#glyph-sets )
* [**Patched Fonts** ](#patched-fonts )
* [**Combinations** ](#combinations )
* [**Font Patcher** ](#font-patcher )
2016-11-23 02:13:37 +02:00
[**Developer / Contributor** ](#font-patcher )
2016-11-21 00:20:55 +02:00
* [**Font Patcher** ](#font-patcher )
* [**Gotta Patch 'em All Font Patcher!** ](#gotta-patch-em-all )
* [**Other Good Fonts to Patch** ](#other-good-fonts-to-patch )
* [**Contributing** ](#contributing )
2016-11-20 18:54:09 +02:00
[**Project History** ](#project-history )
* [**Motivation** ](#motivation-original-rationale )
2016-11-21 00:20:55 +02:00
**Additional Info**
* [**Unstable file paths on master** ](#unstable-file-paths )
* [**Changelog** ](#changelog )
* [**License** ](#license )
2016-11-20 18:54:09 +02:00
2015-08-11 00:33:21 +02:00
2016-11-23 02:13:37 +02:00
## Features
* A [FontForge python script ](#font-patcher ) to patch any font
2016-12-20 22:22:08 +02:00
* **`35`** already [patched font families ](#patched-fonts )
* Over ** `7,400` ** unique combinations/variations of patched fonts [(more details) ](#combinations )
* Over ** `1,300` ** glyphs/icons combined [(more details) ](#combinations )
2016-11-23 02:13:37 +02:00
* Current glyph sets include: [Powerline with Extra Symbols][ryanoasis-powerline-extra-symbols], [Font Awesome][font-awesome], [Devicons][vorillaz-devicons], [Octicons][octicons], [Font Linux][font-linux], [Pomicons][gabrielelana-pomicons]
* A Developer/Contributor provided [bash script ](#gotta-patch-em-all ) to re-patch all the fonts
2015-08-11 00:33:21 +02:00
## Glyph Sets
### Seti-UI + Custom
2016-10-22 17:40:41 +02:00
> Based off of [Seti-UI] Icomoon with extra custom glyphs.
2015-11-26 17:08:46 +02:00
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-1.png )
2015-08-11 00:33:21 +02:00
2015-11-26 17:08:46 +02:00
### [Devicons][vorillaz-devicons]
> An iconic font made for developers, code jedis, ninjas, HTTPsters, evangelists and nerds(sic). / ([repo][vorillaz-devicons]) / ([website](http://vorillaz.github.io/devicons))
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-2.png )
2015-08-11 00:33:21 +02:00
2015-11-26 17:08:46 +02:00
### [Font Awesome][font-awesome]
> The iconic font and CSS toolkit. / ([repo][font-awesome]) / ([website](https://fortawesome.github.io/Font-Awesome))
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-awesome-1.png )
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-awesome-2.png )
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-awesome-3.png )
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-awesome-4.png )
2016-10-30 00:47:36 +02:00
### [Font Awesome Extension][font-awesome-extension]
> Simple Font Awesome Extension. / ([repo][font-awesome-extension]) / ([website](http://andrelgava.github.io/font-awesome-extension/))
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-awesome-extension-1.png )
2015-08-11 00:33:21 +02:00
2015-11-26 17:08:46 +02:00
### [Octicons][octicons]
> GitHub's icons. / ([repo][octicons]) / ([website](https://octicons.github.com))
2016-12-16 21:30:14 +02:00
#### Nerd Font Complete Codepoints:*
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-octicons.png )
2015-08-11 00:33:21 +02:00
2016-12-16 21:30:14 +02:00
< sub > * To avoid conflicts between icon sets, these were modified in the 'Complete' fonts. To view the original codepoints see the [Wiki ](https://github.com/ryanoasis/nerd-fonts/wiki/Codepoint-Conflicts ).</ sub >
2015-11-26 17:08:46 +02:00
### [Powerline Extra Symbols][ryanoasis-powerline-extra-symbols]
2016-10-22 17:40:41 +02:00
> Provides extra Powerline separator glyphs and a column number glyph (CN). / ([repo][ryanoasis-powerline-extra-symbols])
2015-11-26 17:08:46 +02:00
2015-08-11 00:33:21 +02:00
![image ](https://raw.githubusercontent.com/ryanoasis/powerline-extra-symbols/master/fontforge.png )
2015-03-10 00:25:57 +02:00
2016-10-30 00:51:57 +02:00
### [IEC Power Symbols][website-iecpower]
2016-10-30 00:47:36 +02:00
> Adding new characters into Unicode / ([website][website-iecpower])
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-iec-power-1.png )
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-iec-power-2.png )
2016-10-30 00:47:36 +02:00
2016-05-08 22:58:54 +02:00
### [Font Linux][font-linux]
> Font-linux is an icon font containing logos of popular linux distributions for inclusion in websites. / ([repo][font-linux])
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-font-linux.png )
2016-05-08 22:58:54 +02:00
### [Pomicons][gabrielelana-pomicons]
> 8 symbols for the ["Pomodoro Technique"®](http://pomodorotechnique.com). / ([repo][gabrielelana-pomicons])
2016-12-15 03:35:45 +02:00
![image ](https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/fontforge-glyph-set-pomicons.png )
2016-05-08 22:58:54 +02:00
2014-12-05 06:29:54 +02:00
## Patched Fonts
2016-05-08 21:15:43 +02:00
| Font Name | Font Name and Repository | *RFN | EM Size | Status |
2016-05-08 23:09:12 +02:00
|---------------------------------------------------|-----------------------------|------|---------|-------------------|
2016-11-19 05:17:17 +02:00
| [3270 Nerd Font][p-3270] | [3270][f-3270] | NO | 1000 | ![w2] ![m2] ![l2] |
2016-12-15 04:54:42 +02:00
| [Anonymice Nerd Font][p-anonymous-pro] | [Anonymous Pro][f-a-pro] | NO | 2048 | ![w] ![m2] ![l] |
| [Aurulent Sans Mono Nerd Font][p-aurulent] | | NO | 1000 | ![w] ![m2] ![l] |
| [Bitstream Vera Sans Mono Nerd Font][p-bitstream] | | NO | 2048 | ![w] ![m2] ![l] |
| [Code New Roman Nerd Font][p-code-nr] | | NO | 2048 | ![w] ![m2] ![l] |
| [DejaVu Sans Mono Nerd Font][p-dejavu] | | NO | 2048 | ![w] ![m2] ![l] |
| [Droid Sans Mono Nerd Font][p-droid] | | NO | 2048 | ![w] ![m2] ![l] |
| [Fantasque Sans Nerd Font][p-fantasque] | [Fantasque Sans][f-fant] | NO | 2048 | ![w] ![m2] ![l] |
| [Fura Code Nerd Font][p-fira-code] | [Fira][f-fira-code] | YES | 1000 | ![w] ![m2] ![l] |
| [Fura Mono Nerd Font][p-fira-mono] | [Fira][f-fira-mono] | YES | 1000 | ![w] ![m2] ![l] |
2016-11-20 18:36:27 +02:00
| [Gohu Nerd Font][p-gohu] | [Gohu][f-gohu] | NO | 1000 | ![w2] ![m2] ![l2] |
2016-12-15 04:54:42 +02:00
| [Hasklug Nerd Font][p-hasklig] | [Hasklig][f-hasklig] | YES | 1000 | ![w] ![m2] ![l] |
| [Heavy Data Mono Nerd Font][p-heavy-data] | | NO | 2048 | ![w] ![m2] ![l] |
| [Hermut Nerd Font][p-hermit] | | NO | 1000 | ![w] ![m2] ![l] |
| [Inconsolata Nerd Font][p-inconsolata] | | NO | 1000 | ![w] ![m2] ![l] |
2016-10-22 21:30:28 +02:00
| [Iosevka Nerd Font][p-iosevka] | [Iosevka][f-iosevka] | YES | 1000 | [#83][s-iosevka] |
2016-12-15 04:54:42 +02:00
| [Knack Nerd Font][p-hack] | [Hack][f-hack] | YES | 2048 | ![w] ![m2] ![l] |
| [Lekton Nerd Font][p-lekton] | | NO | 1000 | ![w] ![m2] ![l] |
| [Literation Mono Nerd Font][p-liberation] | [Liberation][f-liberation] | YES | 2048 | ![w] ![m2] ![l] |
| [Meslo Nerd Font][p-meslo] | | NO | 2048 | ![w] ![m2] ![l] |
| [Monofur Nerd Font][p-monofur] | | NO | 2400 | ![w] ![m2] ![l] |
| [Monoid Nerd Font][p-monoid] | | NO | 1536 | ![w] ![m2] ![l] |
| [Mononoki Nerd Font][p-mononoki] | [Mononoki][f-mononoki] | NO | 1024 | ![w] ![m2] ![l] |
| [M+ (MPlus) Nerd Font][p-mplus] | | NO | 1000 | ![w] ![m2] ![l] |
| [ProFont (Windows tweaked) Nerd Font][p-profont] | | NO | 1200 | ![w] ![m2] ![l] |
2016-05-08 21:15:43 +02:00
| [ProFont (x11) Nerd Font][p-profont] | | NO | 1000 | [FAILING] |
| [ProggyClean Nerd Font][p-proggy-clean] | | NO | 2048 | [FAILING] |
| [Roboto Mono][p-roboto] | | NO | 2048 | [FAILING] |
2016-12-15 04:54:42 +02:00
| [Sauce Code Nerd Font][p-source-code-pro] | [Source][f-source] | YES | 1000 | ![w] ![m2] ![l] |
| [Shure Tech Mono Nerd Font][p-share-tech-mono] | [Share Tech Mono][f-share] | YES | 1000 | ![w] ![m2] ![l] |
| [Space Mono Nerd Font][p-space-mono] | [Space Mono][f-space] | NO | 1000 | ![w] ![m2] ![l] |
| [Terminess Nerd Font][p-terminus] | [Terminus Font][f-terminus] | YES | 1000 | ![w] ![m2] ![l] |
| [Ubuntu Mono derivative Nerd Font][p-ubuntu] | | NO | 1000 | ![w] ![m2] ![l] |
| [Ubuntu Mono Nerd Font][p-ubuntu] | | NO | 1000 | ![w] ![m2] ![l] |
2016-05-08 21:15:43 +02:00
< sub > _*RFN = Reserved Font Name_< / sub >
2015-08-11 00:33:21 +02:00
2016-11-20 18:46:26 +02:00
## Combinations
2016-12-15 07:15:25 +02:00
* Over `74,000` unique variations/combinations (Power Set) of patched fonts:
* `35` patched font typefaces
* `140` patched font families
* `560` 'complete' variations/combinations
* `73,960` _possible_ variations/combinations
* `74,520` total calculated combinations (560 + 73,960)
2016-11-20 18:46:26 +02:00
* Combinations for each font are any combination of (plus no flags option) [Variations ](#variations )
### Variations
* no flags given (defaults to only [Seti-UI] and [Devicons][vorillaz-devicons])
2016-11-20 18:36:27 +02:00
* *double* (variable/proportional) or *single* (fixed/monospaced) width icons/glyphs
2015-08-11 00:33:21 +02:00
* [Font Awesome][font-awesome]
2016-11-20 18:46:26 +02:00
* [Font Awesome Extension][font-awesome-extension]
2015-08-11 00:33:21 +02:00
* [GitHub Octicons][octicons]
2016-05-08 22:58:54 +02:00
* [Font Linux][font-linux]
2016-11-20 18:36:27 +02:00
* [Powerline Extra Symbols][ryanoasis-powerline-extra-symbols]
* [IEC Power Symbols][website-iecpower]
2015-08-11 00:33:21 +02:00
* [Pomicons][gabrielelana-pomicons]
2016-11-20 18:36:27 +02:00
* Windows Compatibility
2015-08-11 00:33:21 +02:00
2015-11-23 01:50:15 +02:00
## Font Installation
2016-11-21 00:20:55 +02:00
### `Option 1: Install Script`
_Note_: only for Linux & macOS (OS X)
2015-11-23 01:50:15 +02:00
2016-11-21 00:20:55 +02:00
#### All fonts:
* Installs all the patched Fonts (_Warning: This is a lot of Fonts adding up to a large size_)
```sh
./install.sh
```
#### Single font:
* Installs a single Font of your choice
```sh
./install.sh < FontName >
./install.sh Hack
./install.sh HeavyData
```
### `Option 2: Ad Hoc Curl Download`
#### Linux
2015-11-23 01:50:15 +02:00
```sh
mkdir -p ~/.local/share/fonts
2016-02-05 00:23:37 +02:00
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
2015-11-23 01:50:15 +02:00
```
2016-11-21 00:20:55 +02:00
_Note:_ deprecated alternative paths: `~/.fonts`
#### macOS (OS X)
2015-11-23 01:50:15 +02:00
```sh
2016-02-05 00:23:37 +02:00
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
2015-11-23 01:50:15 +02:00
```
2016-11-21 00:20:55 +02:00
### `Option 3: Release Archive Download`
2015-11-26 17:08:46 +02:00
2016-12-23 19:21:36 +02:00
Fonts are available for download as packages in the [latest release ](https://github.com/ryanoasis/nerd-fonts/releases/latest )
2015-11-24 15:23:17 +02:00
2016-11-21 00:20:55 +02:00
### `Option 4: Homebrew Fonts`
2015-08-11 00:33:21 +02:00
2017-01-23 05:17:44 +02:00
All fonts are available via [Homebrew Fonts ](https://github.com/caskroom/homebrew-fonts ) on macOS (OS X)
2016-05-15 05:13:49 +02:00
2017-01-23 05:17:44 +02:00
```sh
brew cask search /nerd/
brew cask install font-hack-nerd-font
```
2017-01-25 04:33:04 +02:00
### `Option 5: Unofficial Arch User Repository (AUR)`
2016-05-15 05:13:49 +02:00
2017-01-25 04:33:04 +02:00
The following fonts are available via [AUR packages ](https://aur.archlinux.org/ ) on Arch Linux:
* [Nerd Fonts Complete ](https://aur.archlinux.org/packages/nerd-fonts-complete/ )
* [Nerd Fonts DejaVu Complete ](https://aur.archlinux.org/packages/nerd-fonts-dejavu-complete/ )
* [Nerd Fonts Source Code Pro Complete ](https://aur.archlinux.org/packages/nerd-fonts-source-code-pro/ )
* [Nerd Fonts Git (out of date) ](https://aur.archlinux.org/packages/nerd-fonts-git/ )
### `Option 6: Download and Install Manually`
2015-08-11 00:33:21 +02:00
2016-11-21 00:20:55 +02:00
Download the specific [patched font ](#patched-fonts ) of your choice
2016-05-15 05:13:49 +02:00
2017-01-25 04:33:04 +02:00
### `Option 7: Clone the Repo`
2016-11-21 00:20:55 +02:00
Cloning of this repository is **not** required nor the most efficient way to get the fonts,
however if you want all the fonts and want to clone be sure to shallow clone:
> `git clone --depth 1`
For more high level information see the [wiki][wiki]. If you are looking for the Vim plugin see [VimDevIcons ➶][vim-devicons].
2017-01-25 04:33:04 +02:00
### `Option 8: Patch Your Own Font`
2016-11-21 00:20:55 +02:00
Use the provided python command line script to generate a patched font from your own font to get the extra new glyphs
See: [Font Patcher ](#font-patcher ) for usage
* use this option if you do __not__ want to use one of the [fonts provided ](#patched-fonts )
2016-11-23 02:13:37 +02:00
* you will still need to copy the generated font to the correct font directory on your system
2016-05-09 10:44:55 +02:00
2015-08-11 00:33:21 +02:00
< h2 align = "center" id = "font-patcher" >
< img src = "images/nerd-fonts-patcher-logo.png" alt = "Nerd Fonts Patcher" >
< / h2 >
2016-11-20 18:36:27 +02:00
Patching the font of your own choosing for use with the [VimDevIcons][vim-devicons]:
2015-08-04 13:12:55 +02:00
* requires: python2, python-fontforge package (version 20141231 or later, see
the [install instructions ](http://designwithfontforge.com/en-US/Installing_Fontforge.html ))
2016-10-22 17:40:41 +02:00
* alternative install method on OSX: `brew install fontforge`
2015-11-11 03:19:56 +02:00
* Usage:
2014-12-05 06:29:54 +02:00
2015-08-11 00:33:21 +02:00
```
./font-patcher PATH_TO_FONT
```
2014-12-05 06:29:54 +02:00
2016-10-22 17:40:41 +02:00
* Alternative usage: Execute the patcher with the FontForge binary using the script flag:
2015-11-11 03:19:56 +02:00
```
./fontforge -script font-patcher PATH_TO_FONT
```
2015-03-01 19:59:09 +02:00
```
2016-10-23 23:23:00 +02:00
usage: font-patcher [-h] [-v] [-s] [-q] [-w] [-c] [--fontawesome]
[--fontawesomeextension] [--fontlinux] [--octicons]
[--powersymbols] [--pomicons] [--powerline]
2016-12-15 07:20:00 +02:00
[--powerlineextra] [--custom [CUSTOM]]
[--postprocess [POSTPROCESS]]
[--progressbars | --no-progressbars] [--careful]
[-ext [EXTENSION]] [-out [OUTPUTDIR]]
2015-08-11 00:33:21 +02:00
font
2014-12-05 06:29:54 +02:00
2016-12-15 07:20:00 +02:00
Nerd Fonts Font Patcher: patches a given font with programming and development related glyphs
Website: https://github.com/ryanoasis/nerd-fonts
2015-03-01 19:59:09 +02:00
positional arguments:
2016-10-23 23:23:00 +02:00
font The path to the font to patch (e.g., Inconsolata.otf)
2015-01-22 03:04:51 +02:00
2015-03-01 19:59:09 +02:00
optional arguments:
-h, --help show this help message and exit
2016-05-08 22:58:54 +02:00
-v, --version show program's version number and exit
2016-12-15 07:20:00 +02:00
-s, --mono, --use-single-width-glyphs
Whether to generate the glyphs as single-width not double-width (default is double-width)
2015-03-01 19:59:09 +02:00
-q, --quiet, --shutup
Do not generate verbose output
2016-12-15 07:20:00 +02:00
-w, --windows Limit the internal font name to 31 characters (for Windows compatibility)
2016-10-23 23:23:00 +02:00
-c, --complete Add all available Glyphs
2016-12-15 07:20:00 +02:00
--fontawesome Add Font Awesome Glyphs (http://fortawesome.github.io/Font-Awesome)
2016-10-23 23:23:00 +02:00
--fontawesomeextension
2016-12-15 07:20:00 +02:00
Add Font Awesome Extension Glyphs (http://andrelgava.github.io/font-awesome-extension)
--fontlinux Add Font Linux Glyphs (https://github.com/Lukas-W/font-linux)
2016-05-08 22:58:54 +02:00
--octicons Add Octicons Glyphs (https://octicons.github.com)
2016-10-23 23:23:00 +02:00
--powersymbols Add IEC Power Symbols (http://unicodepowersymbol.com)
2016-12-15 07:20:00 +02:00
--pomicons Add Pomicon Glyphs (https://github.com/gabrielelana/pomicons)
2015-11-16 01:50:11 +02:00
--powerline Add Powerline Glyphs
2016-12-15 07:20:00 +02:00
--powerlineextra Add Powerline Glyphs (https://github.com/ryanoasis/powerline-extra-symbols)
--custom [CUSTOM] Specify a custom symbol font. All new glyphs will be copied, with no scaling applied.
--postprocess [POSTPROCESS]
Specify a Script for Post Processing
--progressbars Show percentage completion progress bars per Glyph Set
--no-progressbars Don't show percentage completion progress bars per Glyph Set
2015-11-16 01:50:11 +02:00
--careful Do not overwrite existing glyphs if detected
2016-10-23 23:23:00 +02:00
-ext [EXTENSION], --extension [EXTENSION]
Change font file type to create (e.g., ttf, otf)
2015-11-16 01:50:11 +02:00
-out [OUTPUTDIR], --outputdir [OUTPUTDIR]
The directory to output the patched font file to
2015-03-01 19:59:09 +02:00
```
2015-11-26 17:08:46 +02:00
#### Examples
2015-03-01 19:59:09 +02:00
2016-11-18 07:13:10 +02:00
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf -s -q
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --use-single-width-glyphs --quiet
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf -w
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --windows --quiet
./font-patcher Droid\ Sans\ Mono\ for\ Powerline.otf --windows --pomicons --quiet
2015-08-11 00:33:21 +02:00
./font-patcher Inconsolata.otf --fontawesome
./font-patcher Inconsolata.otf --fontawesome --octicons --pomicons
2014-12-05 06:29:54 +02:00
./font-patcher Inconsolata.otf
2015-08-11 00:33:21 +02:00
< a name = "gotta-patch-em-all" > < / a >
## Gotta Patch 'em All Font Patcher!
2016-10-22 17:40:41 +02:00
* for Contributor or Developer use
* re-patches **all** fonts in the unpatched directory:
2015-08-11 00:33:21 +02:00
```
./gotta-patch-em-all-font-patcher\!.sh
2016-10-22 17:40:41 +02:00
```
* can optionally limit to specific font name pattern:
```
2015-08-11 00:33:21 +02:00
./gotta-patch-em-all-font-patcher\!.sh Hermit
```
2015-11-11 17:23:50 +02:00
2016-11-23 02:13:37 +02:00
## Contributing
See [contributing.md ](contributing.md )
2016-11-18 07:13:10 +02:00
## Unstable File Paths
2015-11-11 17:23:50 +02:00
| Unstable file paths warning |
-------------------------------
2016-11-18 07:13:10 +02:00
| Reference the **release** branch and _not_ the ~~master~~ branch because paths are subject change for each release |
| For example: |
| Use: https://github.com/ryanoasis/nerd-fonts/blob/0.9.0/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf |
| Not: ~~https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf~~ |
2015-11-11 17:23:50 +02:00
2016-11-23 02:13:37 +02:00
2015-08-11 00:33:21 +02:00
## Other Good Fonts to Patch
* a list of additional good fonts to patch that I cannot provide or share due to the license:
2016-10-23 23:23:00 +02:00
* [Input Mono][input-mono] (license restriction)
* Possibly coming with external hosting :)
* [PragmataPro][pragmatapro] (not free)
* [Consolas][consolas] (proprietary)
2015-08-11 00:33:21 +02:00
2016-11-23 02:13:37 +02:00
2016-05-15 05:13:49 +02:00
## Project History
2015-08-11 00:33:21 +02:00
2016-05-15 05:13:49 +02:00
### Motivation (Original Rationale)
2015-08-11 00:33:21 +02:00
2016-10-22 17:40:41 +02:00
* 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. This project began as a part of the [vim-devicons] repo but soon it became apparent it did not belong tied to the vim plugin. I thought it may benefit others more as a separate project and allow a wider range of uses. This project started before I knew about Fontconfig provided solution, although a patched font still has some benefits over the Fontconfig.
2015-08-11 00:33:21 +02:00
2016-05-15 05:13:49 +02:00
* project and repository previously known as 'nerd-filetype-glyphs-fonts-patcher' and 'font-nerd-icons'
2015-08-11 00:33:21 +02:00
2016-05-15 20:03:03 +02:00
## Changelog
See [changelog.md ](changelog.md )
2014-12-05 06:29:54 +02:00
## License
2016-05-15 20:04:35 +02:00
[MIT ](LICENSE ) © Ryan L McIntyre
2015-08-11 00:33:21 +02:00
2016-05-08 22:58:54 +02:00
<!--
Repo References
-->
2015-08-11 00:33:21 +02:00
[vim-devicons]:https://github.com/ryanoasis/vim-devicons
[vorillaz-devicons]:http://vorillaz.github.io/devicons/
[font-awesome]:https://github.com/FortAwesome/Font-Awesome
2016-10-30 00:47:36 +02:00
[font-awesome-extension]:https://github.com/AndreLGava/font-awesome-extension
2015-08-11 00:33:21 +02:00
[octicons]:https://github.com/github/octicons
2016-05-08 22:58:54 +02:00
[font-linux]:https://github.com/Lukas-W/font-linux
2015-08-11 00:33:21 +02:00
[gabrielelana-pomicons]:https://github.com/gabrielelana/pomicons
[Seti-UI]:https://atom.io/themes/seti-ui
[ryanoasis-powerline-extra-symbols]:https://github.com/ryanoasis/powerline-extra-symbols
2016-03-15 15:03:39 +02:00
[wiki]:https://github.com/ryanoasis/nerd-fonts/wiki
2016-11-19 17:03:05 +02:00
[repo]:https://github.com/ryanoasis/nerd-fonts
[gitter]:https://gitter.im/ryanoasis/nerd-fonts
2015-10-15 04:21:16 +02:00
2016-10-30 00:47:36 +02:00
<!--
Website References
-->
[website-iecpower]:http://unicodepowersymbol.com/
2016-05-08 22:58:54 +02:00
<!--
2015-10-15 04:21:16 +02:00
Link References
-->
[badge-version]:http://badge.fury.io/gh/ryanoasis%2Fnerd-fonts
[badge-gitter]:https://gitter.im/ryanoasis/nerd-fonts?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge
2016-11-19 05:17:17 +02:00
[img-version-badge-with-logo]:https://img.shields.io/github/release/ryanoasis/nerd-fonts.svg?style=flat-square& logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAEAAAAAeCAYAAACc7RhZAAAABmJLR0QA%2FwD%2FAP%2BgvaeTAAAACXBIWXMAABJ0AAASdAHeZh94AAAAB3RJTUUH4AsTAw4JCvVTMQAABhNJREFUWMPtmX2MnFUVxs%2BdmZ3dYit0DaQKVfmwLaAxRQhIaqKpaCBSkCbQAkEUY0KFxFAkAomdaDeCCuJHqgQCQvnQjYABJEZJs2AhDS4xCIvgaDutsFmWmTLs7sz7dc%2Fv%2Bgd3zJvJu7O73bF2iTfZ7Mw79557nueee%2B5z7ivy%2F7Zwmqp%2BFRgBGoAFqsAu4HZVvTwMw%2BPelcCbzeb7gSeccw5QoO6macBuYJu1dt3Y2NhhCx68tfYc4E0P7o9RFJ1QLpeLqnop8BfXoQEB8JiqXlar1ZYsKOCjo6OLgJ%2B1Vl1VbyyVSiaDoLOAJzuQ8CKQAG%2Br6jXt482hCD5JktPy%2Bfx2Y8xK51wIXFIoFB6eYczp%2BXx%2BwBizVkTEOTcpIvtEJBaRpv%2BrOeeeE5E%2BEdmTz%2Bd%2FdUgBHxwczAFbgMSvXsNa%2B%2BnZjK1UKr1JkpwJ3AfsAP4KhB0iIxoeHi5IHMerVfU6a%2B0Xp6amjvpfEgDclnKwYa39zHR9a7XaEmvtOuBmYGcnsG3A3wT%2B7JxztVptiajqxtSPU8D3G43GsoMNvlQqGaDh%2FYittZ%2FP6hdF0QrgDmA%2FMAS8nfLf%2Bj3%2FMHCTqm4GbgO2AQNADLwM7AH%2B1Uoi506TPX8eRdEJB5mAt3gn421s%2F71cLhc9iBqwHXgQmAT2AT%2B01p6dlekrlUovMAiMAb9PYfydiIiJomhlsVh8Jcsp5xwi8oiq3trT0%2FNsJwDj4%2BPvWbp06epcLrfKGHO0iBwlIv0iskREFolIr4gURCQnIioiiYg0RGRCRMacc3tFJOece7lQKDzRluDOyOfz20TknyISicg5IvIocPfWrVufLpVKbqbcsn79%2Bq8bYzYYY8702L6Ty%2BW2tPbemFdUj7VFggL%2FAP4O7LLWXpAWJ6p6CfAL4AUffuqFyC7gGR9qs9qbqTnHgSFV%2FbaqfgP4A%2B%2B0Ma8AH5iamjryABPsZGueOI4%2F9p9jELhXRC4IguD4vr6%2Bi4wxtxhjCqlIeFVEHhWRk0TkAyLSZ4w50TkXiMiQc26nX83DjTGrROQUEfmIMSbnnLP%2BKApFpCoi4%2F7%2FlIgcISKrfcTM2Jxzcb1eP7K%2Fv39irgREUbSiWCy%2B6u08n8vlTk2LifM9%2B9%2F1mnsDoBmr81tr7ReAHaq6WVWvBR5p7V3gSVX9chzHH200GssqlUrvbJwLguCDqropndCmiY7n56Eo17bsqOrFWQnmDaAZBMFyT8IVgM1wIgSabc8Goyg6sRvFzgwE%2FGYeti%2FyNl4fHh4uZHX4GhCq6hXpyACCDEde8pFQUdUbu6j7z8qYazIljAbmQcAmb%2BMHc5Wla4DxDMfUOeeiKFrVxXJ3U8r%2B42EYHu%2BJWeefPTRXm5VKpbderx8B%2FMiH%2F1fm7FgQBMuB57LCspVNu6QE7%2FFAx0ZHRxel5j%2FGP39raGgoP0dSb1DVbwEjzjmXJMmpB%2BScFxS3txOQJMmaLhKw1wO9uT1HtebrJI8zwG8EGqp6vbe7N6uinGuYXpi%2BkLDWntsN8FEUrUqR%2BokMcnZ7ENtnc%2BS1VJ%2BXvkNZxM7H2RWt5Kiql3dp%2F1%2FnnfzbNNFxS0vvJ0lyegc732yJLy%2FEnvKfk65Ke%2BBuT8DmeRC5Evj1yMhID7Crk71Go7EMmPBgRuM4%2FnhGwj7D3xkOqOqVwJ9SSfWmrl9QHqjharW62JexMfBCHMcnt4qwycnJ93U4Js9LHYkR8NMkSdbU6%2FXDR0ZGesIw%2FJCqXgbsSAGPgYF57%2F3plBXwy7kKEuA1P7bsV%2FYu%2F%2F3HszyWn5lFTREC98VxfPJ%2FpXwNw%2FBYP9HO2fSP4%2FiktpUZDoLgGFX9Umu%2FVqvVxXNYgPW%2B9m96GV4HnlbVq6y1n5uYmOg%2FGDc4u4Gw2WwePYu%2B96dC8idenHzPV5FRkiSfWogvKm5oXVfv37%2F%2FvTNEwGpVvdpa%2B1mgBLzux6KqGxbknb1PZns8kH3AliRJPhkEwfJqtbo4CILl1tq1vq6%2FtyV0UtugYq09f0G%2FuAjD8NjpZHKHC4%2BHVPXicrlclHdDK5VKxlp7NnAr8Kx%2FEQEw6r%2FfqaobwjD88KHm%2B78BVBigctRUCFcAAAAASUVORK5CYII%3D
2016-11-19 17:03:05 +02:00
[img-gitter-badge]:https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square
2016-03-20 21:56:48 +02:00
2016-10-23 23:23:00 +02:00
[consolas]:https://www.microsoft.com/typography/fonts/family.aspx?FID=300
[input-mono]:http://input.fontbureau.com/download/
[pragmatapro]:http://www.fsd.it/shop/fonts/pragmatapro/
2016-12-23 19:21:36 +02:00
[latest-release]:https://github.com/ryanoasis/nerd-fonts/releases/latest
2016-03-20 21:56:48 +02:00
<!--
Font repos
-->
2016-05-08 22:58:54 +02:00
2016-05-08 21:15:43 +02:00
[f-hack]:https://github.com/chrissimpkins/Hack
2016-05-08 21:31:21 +02:00
[f-a-pro]:http://www.marksimonson.com/fonts/view/anonymous-pro
2016-10-22 16:53:46 +02:00
[f-3270]:https://github.com/rbanffy/3270font
2016-05-08 21:15:43 +02:00
[f-source]:https://github.com/adobe-fonts/source-code-pro
[f-liberation]:https://fedorahosted.org/liberation-fonts
[f-terminus]:http://terminus-font.sourceforge.net
[f-fira-mono]:https://github.com/mozilla/Fira
[f-fira-code]:https://github.com/tonsky/FiraCode
[f-monoid]:https://github.com/larsenwork/monoid
[f-iosevka]:https://github.com/be5invis/Iosevka
2016-05-08 21:31:21 +02:00
[f-fant]:https://github.com/belluzj/fantasque-sans
2016-10-22 21:30:28 +02:00
[f-share]:https://fonts.google.com/specimen/Share+Tech+Mono
[f-space]:https://fonts.google.com/specimen/Space+Mono
[f-gohu]:http://font.gohu.org/
[f-mononoki]:http://madmalik.github.io/mononoki/
[f-hasklig]:https://github.com/i-tu/Hasklig
2016-03-20 21:56:48 +02:00
2016-05-08 21:15:43 +02:00
<!--
Patched Font internal links
-->
2016-05-08 22:58:54 +02:00
2016-05-08 21:15:43 +02:00
[p-3270]:patched-fonts/3270
2016-05-08 23:09:12 +02:00
[p-anonymous-pro]:patched-fonts/AnonymousPro
2016-05-08 21:15:43 +02:00
[p-aurulent]:patched-fonts/AurulentSansMono
[p-bitstream]:patched-fonts/BitstreamVeraSansMono
[p-dejavu]:patched-fonts/DejaVuSansMono
[p-droid]:patched-fonts/DroidSansMono
2016-05-08 21:31:21 +02:00
[p-fantasque]:patched-fonts/FantasqueSansMono
2016-05-08 21:15:43 +02:00
[p-fira-code]:patched-fonts/FiraCode
[p-fira-mono]:patched-fonts/FiraMono
[p-heavy-data]:patched-fonts/HeavyData
[p-hermit]:patched-fonts/Hermit
[p-inconsolata]:patched-fonts/Inconsolata
[p-iosevka]:patched-fonts/Iosevka
[p-hack]:patched-fonts/Hack
[p-lekton]:patched-fonts/Lekton
[p-liberation]:patched-fonts/LiberationMono
[p-meslo]:patched-fonts/Meslo
[p-monofur]:patched-fonts/Monofur
[p-monoid]:patched-fonts/Monoid
[p-mplus]:patched-fonts/MPlus
2016-10-20 21:03:03 +02:00
[p-profont]:patched-fonts/ProFont
2016-05-08 21:15:43 +02:00
[p-proggy-clean]:patched-fonts/ProggyClean
[p-roboto]:patched-fonts/RobotoMono
[p-source-code-pro]:patched-fonts/SourceCodePro
[p-terminus]:patched-fonts/Terminus
[p-ubuntu]:patched-fonts/UbuntuMono
2016-10-22 21:30:28 +02:00
[p-share-tech-mono]:patched-fonts/ShareTechMono
[p-space-mono]:patched-fonts/SpaceMono
[p-gohu]:patched-fonts/Gohu
[p-mononoki]:patched-fonts/Mononoki
[p-code-nr]:patched-fonts/CodeNewRoman
[p-hasklig]:patched-fonts/Hasklig
2016-05-08 21:15:43 +02:00
2016-12-23 19:21:36 +02:00
<!--
Quick Link Images
-->
[ql-1]:images/nerd-fonts-character-logo-md.png "Latest Release (external link) ➶"
[ql-2]:images/nerd-fonts-character-logo-md.png "↓ View Patched Fonts List ↓"
[ql-3]:images/nerd-fonts-patcher-logo-md.png "↓ Font Patcher Details ↓"
[ql-4]:https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v1.0.0/branding-logo-sm.png "VimDevIcons Vim Plugin (external link) ➶"
[ql-5]:images/nerd-fonts-character-logo-md.png "Font Package Archive (Zip) Downloads (external link) ➶"
2016-05-08 21:15:43 +02:00
<!--
Patched Font Statuses
-->
2016-05-08 22:58:54 +02:00
2016-12-15 03:35:45 +02:00
[w-top]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/windows-pass-sm.png "↓ Windows Compatibility Status ↓"
[l-top]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/linux-pass-sm.png "↓ Linux Compatibility Status ↓"
[m-top]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/mac-pass-sm.png "↓ macOS (OSX) Compatibility Status ↓"
2016-11-18 06:46:22 +02:00
2016-12-15 03:35:45 +02:00
[w]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/windows-pass-sm.png "Windows status is working ☺"
[l]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/linux-pass-sm.png "Linux status is working ☺"
[m]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/mac-pass-sm.png "macOS (OSX) status is working ☺"
2016-11-18 04:57:07 +02:00
2016-12-15 03:35:45 +02:00
[w2]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/windows-unknown-sm.png "Windows status is Unknown/Un-tested"
[l2]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/linux-unknown-sm.png "Linux status is Unknown/Un-tested"
[m2]:https://github.com/ryanoasis/nerd-fonts/wiki/screenshots/v1.0.x/mac-unknown-sm.png "macOS (OSX) status is Unknown/Un-tested"
2016-11-18 04:19:19 +02:00
2016-05-14 17:18:12 +02:00
[s-iosevka]:https://github.com/ryanoasis/nerd-fonts/issues/83