1
0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-11-19 16:39:20 +02:00
nerd-fonts/readme.md

192 lines
9.0 KiB
Markdown
Raw Normal View History

<h1 align="center">
<img src="images/nerd-fonts-logo.png" alt="nerd fonts">
</h1>
[![GitHub version](https://badge.fury.io/gh/ryanoasis%2Fnerd-fonts.svg)](http://badge.fury.io/gh/ryanoasis%2Fnerd-fonts)
***
| **[Fonts](#patched-fonts)** | **[Patcher](#font-patcher)** |
|-------------------------------------|-------------------------------|
| [![fonts-logo-small](images/nerd-fonts-character-logo-md.png)](#patched-fonts) | [![patcher-logo-small](images/nerd-fonts-patcher-logo-md.png)](#font-patcher) |
***
* A [fontforge python script](#font-patcher) to patch any font
* Over **20** already [patched font families](#patched-fonts)
* Over **350** unique permutations/variations of patched fonts [(more details)](#permutations)
## Table of Contents
- [font nerd icons](#)
- [Glyph sets](#glyph-sets)
- [Usage](#usage)
- [Patched Fonts List](#patched-fonts)
- [Permutations](#permutations)
- [Font Install Script (Linux & Mac OS X)](#font-install-script)
- [Font Patcher](#font-patcher)
- [Gotta Patch 'em All Font Patcher!](#gotta-patch-em-all)
- [Other Good Fonts to Patch](#other-good-fonts-to-patch)
- [Rationale](#rationale)
- [Other](#other)
- [License](#license)
## Glyph Sets
### Set 1: Seti-UI + Custom
* [Seti-UI] / icomoon plus misc custom glyphs
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-1.png)
### Set 2: [devicons][vorillaz-devicons]
* [devicons][vorillaz-devicons] from [vorillaz-devicons]
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-2.png)
### Set 3: [Pomicons][gabrielelana-pomicons]
* [Pomicons][gabrielelana-pomicons] from [gabrielelana-pomicons]
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-3.png)
### Set 4: [powerline-extra-symbols][ryanoasis-powerline-extra-symbols]
* Work In Progress... :)
![image](https://raw.githubusercontent.com/ryanoasis/powerline-extra-symbols/master/fontforge.png)
## Usage
### Option A
Install any of the already [provided patched fonts](#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](#font-patcher) for usage
* use this option if you do __not__ want to use one of the [fonts provided](#patched-fonts)
## Patched Fonts
| Font Name | em size | status |
|-------------------------------------------------------------------------------------------|----------|--------------------------|
| [3270 Plus Nerd File Types](patched-fonts/3270) | 1000 | [TEST] |
| [Anonymice Powerline Plus Nerd File Types](patched-fonts/AnonymousPro) | 2048 | [TEST] |
| [Aurulent Sans Mono Plus Nerd File Types](patched-fonts/AurulentSansMono) | 1000 | [TEST] |
| [Bitstream Vera Sans Mono Plus Nerd File Types](patched-fonts/BitstreamVeraSansMono) | 2048 | [TEST] |
| [DejaVu Sans Mono Plus Nerd File Types](patched-fonts/DejaVuSansMono) | 2048 | [TEST] |
| [Droid Sans Mono for Powerline Plus Nerd File Types](patched-fonts/DroidSansMono) | 2048 | [TEST] |
| [Fira Mono for Powerline Plus Nerd File Types](patched-fonts/FiraMono) | 1000 | [TEST] |
| [Heavy Data Mono for Powerline Plus Nerd File Types](patched-fonts/HeavyData) | 2048 | [TEST] |
| [Inconsolata for Powerline Plus Nerd File Types](patched-fonts/Inconsolata) | 1000 | [TEST] |
| [Lekton for Powerline Plus Nerd File Types](patched-fonts/Lekton) | 1000 | [TEST] |
| [Literation Mono for Powerline Plus Nerd File Types](patched-fonts/LiberationMono) | 2048 | [TEST] |
| [Meslo for Powerline Plus Nerd File Types](patched-fonts/Meslo) | 2048 | [TEST] |
| [Monofur for Powerline Plus Nerd File Types](patched-fonts/Monofur) | 2400 | [TEST] |
| [M+ (MPlus) for Powerline Plus Nerd File Types](patched-fonts/MPlus) | 1000 | [TEST] |
| [ProFont (Windows tweaked) for Powerline Plus Nerd File Types](patched-fonts/Profont) | 1200 | [TEST] |
| [ProFont (x11) for Powerline Plus Nerd File Types](patched-fonts/ProFont) | 1000 | [FAIL] |
| [ProggyCleanTT Plus Nerd File Types](patched-fonts/ProggyClean) | 2048 | [MISSING POWERLINE GLYPHS](https://github.com/ryanoasis/nerd-fonts/issues/16) |
| [Sauce Code Powerline Plus Nerd File Types](patched-fonts/SourceCodePro) | 1000 | [TEST] |
| [Terminess for Powerline Plus Nerd File Types](patched-fonts/Terminus) | 1000 | [FAIL](https://github.com/ryanoasis/nerd-fonts/issues/16) |
| [Ubuntu Mono derivative Powerline Plus Nerd File Types](patched-fonts/UbuntuMono) | 1000 | [TEST] |
| [Ubuntu Mono Plus Nerd File Types](patched-fonts/UbuntuMono) | 1000 | [TEST] |
* Variations include:
* extra glyphs that are *double* or *single* (monospaced) width
2015-07-10 14:34:26 +02:00
* [Pomicons][gabrielelana-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][gabrielelana-pomicons]
## Font Install Script
* Linux & Mac OS X
> ./install.sh
### Examples
./install.sh
All fonts installed to /home/ryan/.fonts
<h2 align="center" id="font-patcher">
<img src="images/nerd-fonts-patcher-logo.png" alt="Nerd Fonts Patcher">
</h2>
Patching the font of your own choosing for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin:
* requires: python2, python-fontforge package (version 20141231 or later)
* 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
<a name="gotta-patch-em-all"></a>
## 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](http://input.fontbureau.com/)
* [PragmataPro](http://www.fsd.it/fonts/pragmatapro.htm)
## 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', 'font-nerd-icons'
2015-07-01 13:11:52 +02:00
## License
2015-07-01 13:11:52 +02:00
see [LICENSE](LICENSE)
[vim-webdevicons]:https://github.com/ryanoasis/vim-webdevicons
[vorillaz-devicons]:http://vorillaz.github.io/devicons/
[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