fonts/nerd-fonts
1
0
Fork 0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-11-19 16:39:20 +02:00
Code Issues Releases Activity
56a25d29b4
nerd-fonts/readme.md

175 lines
10 KiB
Markdown
Raw Normal View History

Update readme.md * rebrand * shield for version number
2015-06-26 23:03:01 +02:00
font nerd icons
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
=========================================
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
[![GitHub version](https://badge.fury.io/gh/ryanoasis%2Ffont-nerd-icons.svg)](http://badge.fury.io/gh/ryanoasis%2Ffont-nerd-icons)
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
* A [fontforge python script](#font-patcher) to patch any font
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
* Over 20 already [patched font families](#patched-fonts)
* 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
Update readme.md More formatting fixes and tweaks
2015-06-28 15:44:25 +02:00
* Windows Compatible
* Pomicons
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
## Glyph set 1 ([Seti-UI] / icomoon plus misc custom glyphs)
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-1.png)
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
Add pomicon glyphs option to patcher and repatch all fonts * adds option to patcher * updates readme * misc readme updates and code clean-up
2015-06-24 02:47:06 +02:00
## Glyph set 2 (devicons from [vorillaz-devicons])
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-2.png)
Add pomicon glyphs option to patcher and repatch all fonts * adds option to patcher * updates readme * misc readme updates and code clean-up
2015-06-24 02:47:06 +02:00
## Glyph set 3 (pomicons from [gabrielelana-pomicons])
![image](https://github.com/ryanoasis/nerd-filetype-glyphs-fonts-patcher/wiki/screenshots/v0.3.0/fontforge-glyph-set-3.png)
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
## Usage
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
### Option A
Updated readme with better description and explanation of the options available * updates the changelog as well
2015-01-22 03:04:51 +02:00
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
Install any of the already [provided patched fonts](#patched-fonts)
Updated readme with better description and explanation of the options available * updates the changelog as well
2015-01-22 03:04:51 +02:00
### 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)
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
## Patched Fonts
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
| Currently Included Patched Fonts (extra glyphs are *double* width) | em size | status |
|-------------------------------------------------------------------------------------------|----------|--------------------------|
| [3270 Plus Nerd File Types](patched-fonts/3270) | 1000 | [OKAY] |
| [Anonymice Powerline Plus Nerd File Types](patched-fonts/AnonymousPro) | 2048 | [OKAY] |
| [Aurulent Sans Mono Plus Nerd File Types](patched-fonts/AurulentSansMono) | 1000 | [OKAY] |
| [Bitstream Vera Sans Mono Plus Nerd File Types](patched-fonts/BitstreamVeraSansMono) | 2048 | [OKAY] |
| [DejaVu Sans Mono Plus Nerd File Types](patched-fonts/DejaVuSansMono) | 2048 | [OKAY] |
| [Droid Sans Mono for Powerline Plus Nerd File Types](patched-fonts/DroidSansMono) | 2048 | [OKAY] |
| [Fira Mono for Powerline Plus Nerd File Types](patched-fonts/FiraMono) | 1000 | [OKAY] |
| [Heavy Data Mono for Powerline Plus Nerd File Types](patched-fonts/HeavyData) | 2048 | [OKAY] |
| [Inconsolata for Powerline Plus Nerd File Types](patched-fonts/Inconsolata) | 1000 | [OKAY] |
| [Lekton for Powerline Plus Nerd File Types](patched-fonts/Lekton) | 1000 | [OKAY] |
| [Literation Mono for Powerline Plus Nerd File Types](patched-fonts/LiberationMono) | 2048 | [OKAY] |
| [Meslo for Powerline Plus Nerd File Types](patched-fonts/Meslo) | 2048 | [OKAY] |
| [Monofur for Powerline Plus Nerd File Types](patched-fonts/Monofur) | 2400 | [OKAY] |
| [M+ (MPlus) for Powerline Plus Nerd File Types](patched-fonts/MPlus) | 1000 | [OKAY] |
| [ProFont (Windows tweaked) for Powerline Plus Nerd File Types](patched-fonts/Profont) | 1200 | [OKAY] |
| [ProFont (x11) for Powerline Plus Nerd File Types](patched-fonts/ProFont) | 1000 | [FAIL] |
| [ProggyCleanTT Plus Nerd File Types](patched-fonts/ProggyClean) | 2048 | [OKAY] |
| [Sauce Code Powerline Plus Nerd File Types](patched-fonts/SourceCodePro) | 1000 | [OKAY] |
| [Terminess for Powerline Plus Nerd File Types](patched-fonts/Terminus) | 1000 | [OKAY] |
| [Ubuntu Mono derivative Powerline Plus Nerd File Types](patched-fonts/UbuntuMono) | 1000 | [OKAY] |
| [Ubuntu Mono Plus Nerd File Types](patched-fonts/UbuntuMono) | 1000 | [OKAY] |
| Currently Included Absolute Mono Patched Fonts (extra glyphs are *single* width) | em size | status |
|-------------------------------------------------------------------------------------------|-------------------------------------|
| [3270 Plus Nerd File Types Mono](patched-fonts/3270) | 2048 | [OKAY] |
| [Anonymice Powerline Plus Nerd File Types Mono](patched-fonts/AnonymousPro) | 2048 | [OKAY] |
| [Aurulent Sans Mono Plus Nerd File Types Mono](patched-fonts/AurulentSansMono) | 1000 | [OKAY] |
| [Bitstream Vera Sans Mono Plus Nerd File Types Mono](patched-fonts/BitstreamVeraSansMono) | 2048 | [OKAY] |
| [DejaVu Sans Mono Plus Nerd File Types Mono](patched-fonts/DejaVuSansMono) | 2048 | [OKAY] |
| [Droid Sans Mono for Powerline Plus Nerd File Types Mono](patched-fonts/DroidSansMono) | 2048 | [OKAY] |
| [Fira Mono for Powerline Plus Nerd File Types Mono](patched-fonts/FiraMono) | 1000 | [OKAY] |
| [Heavy Data Mono for Powerline Plus Nerd File Types Mono](patched-fonts/HeavyData) | 2048 | [OKAY] |
| [Inconsolata for Powerline Plus Nerd File Types Mono](patched-fonts/Inconsolata) | 1000 | [OKAY] |
| [Lekton for Powerline Plus Nerd File Types Mono](patched-fonts/Lekton) | 1000 | [OKAY] |
| [Literation Mono for Powerline Plus Nerd File Types Mono](patched-fonts/LiberationMono) | 2048 | [OKAY] |
| [Meslo for Powerline Plus Nerd File Types Mono](patched-fonts/Meslo) | 2048 | [OKAY] |
| [Monofur for Powerline Plus Nerd File Types Mono](patched-fonts/Monofur) | 2400 | [OKAY] |
| [M+ (MPlus) for Powerline Plus Nerd File Types Mono](patched-fonts/MPlus) | 1000 | [OKAY] |
| [ProFont (Windows tweaked) for Powerline Plus Nerd File Types Mono](patched-fonts/Profont)| 1200 | [OKAY] |
| [ProFont (x11) for Powerline Plus Nerd File Types Mono](patched-fonts/Profont) | 1000 | [FAIL] |
| [ProggyCleanTT Plus Nerd File Types Mono](patched-fonts/ProggyClean) | 2048 | [OKAY] |
| [Sauce Code Powerline Plus Nerd File Types Mono](patched-fonts/SourceCodePro) | 1000 | [OKAY] |
| [Terminess for Powerline Plus Nerd File Types Mono](patched-fonts/Terminus) | 1000 | [OKAY] |
| [Ubuntu Mono derivative Powerline Plus Nerd File Types Mono](patched-fonts/UbuntuMono) | 1000 | [OKAY] |
| [Ubuntu Mono Plus Nerd File Types Mono](patched-fonts/UbuntuMono) | 1000 | [OKAY] |
## 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)
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
Update readme.md More formatting fixes and tweaks
2015-06-28 15:44:25 +02:00
## Font Install Script (Linux & Mac OS X)
Bumped version to 0.2.1 and added install script details to readme
2015-06-21 18:53:42 +02:00
> ./install.sh
### Examples
./install.sh
All fonts installed to /home/ryan/.fonts
Updated readme with better description and explanation of the options available * updates the changelog as well
2015-01-22 03:04:51 +02:00
## Font Patcher
Patching the font of your own choosing for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin:
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
* requires: python2, python-fontforge package
* usage:
Update readme.md More formatting fixes and tweaks
2015-06-28 15:44:25 +02:00
```
./font-patcher PATH_TO_FONT
```
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
```
Update readme.md * updated font patcher usage and examples
2015-06-24 01:55:26 +02:00
usage: font-patcher [-h] [-s] [-q] [-w] font
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
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)
Updated readme with better description and explanation of the options available * updates the changelog as well
2015-01-22 03:04:51 +02:00
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
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
Update readme.md * updated font patcher usage and examples
2015-06-24 01:55:26 +02:00
-w, --windows, --limit-font-name-length
Limit the internal font name to a maximum of 31
characters (for safe Windows compatiblity)
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
--pomicons Add Pomicon Glyphs
(https://github.com/gabrielelana/pomicons)
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
2015-03-01 19:59:09 +02:00
```
### 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
Update readme.md * updated font patcher usage and examples
2015-06-24 01:55:26 +02:00
./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
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf --windows --pomicons --quiet
v0.1.0 inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
2014-12-05 06:29:54 +02:00
./font-patcher Inconsolata.otf
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
## Gotta Patch 'em All Font Patcher!
* re-patches **all** fonts in the unpatched directory
* mostly for Contributor/Dev use only
Update readme.md More formatting fixes and tweaks
2015-06-28 15:44:25 +02:00
```
./gotta-patch-em-all-font-patcher\!.sh
```
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
## Rationale
Readme updates for v0.3.0 * updated and fixed the fonts tables/lists * added info on patching all the fonts * misc improvements and links
2015-06-24 01:46:19 +02:00
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
* 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
Update readme.md * rebrand * shield for version number
2015-06-26 23:03:01 +02:00
## Other
* previously known as 'nerd-filetype-glyphs-fonts-patcher'
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
Update readme.md License to the bottom
2015-07-01 13:11:52 +02:00
## License
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
Update readme.md License to the bottom
2015-07-01 13:11:52 +02:00
see [LICENSE](LICENSE)
Update readme.md Fixes, reorganization and made a bit more readable and 'to the point'
2015-06-28 15:33:52 +02:00
[vim-webdevicons]:https://github.com/ryanoasis/vim-webdevicons
[vorillaz-devicons]:http://vorillaz.github.io/devicons/
[gabrielelana-pomicons]:https://github.com/gabrielelana/pomicons
Added links to all font folders, fixed example of font-patcher, misc verbiage about permutations, misc readability tweaks
2015-07-01 21:26:22 +02:00
[Seti-UI]:https://atom.io/themes/seti-ui
Reference in New Issue Copy Permalink