#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts

This commit is contained in:
ryanoasis 2015-03-01 12:59:09 -05:00
parent a7b979e3fc
commit 54d6559502

View file

@ -1,10 +1,13 @@
nerd-filetype-glyphs-fonts-patcher
==================================
nerd-filetype-glyphs-fonts-patcher v0.2.0
=========================================
* A python fontforge command line script to patch any font for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin
* Adds the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) glyphs (icons) to any font you pass in
* patched-fonts folder contains pre-patched fonts provided for use with [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) [(see list below)](#patched-fonts)
![image](https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.3.4/fontforge-glyph-set-1.png)
... and more ...
## Usage
### Option A
@ -23,16 +26,27 @@ See: [Font Patcher](#font-patcher) for usage
## Patched Fonts
| Currnetly Included Patched Fonts | em size |
|--------------------------------------------------------|----------|
| Anonymice Powerline Plus Nerd File Types | 2048 |
| Droid Sans Mono for Powerline Plus Nerd File Types | 2048 |
| Literation Mono Powerline Plus Nerd File Types | 2048 |
| PragmataPro for Powerline Plus Nerd File Types | 2048 |
| ProggyCleanTT Plus Nerd File Types | 2048 |
| Sauce Code Powerline Plus Nerd File Types | 1000 |
| Ubuntu Mono derivative Powerline Plus Nerd File Types | 1000 |
| Ubuntu Mono Plus Nerd File Types | 1000 |
| Currently Included Patched Fonts (double width glyphs) | em size |
|-------------------------------------------------------------|----------|
| Anonymice Powerline Plus Nerd File Types | 2048 |
| Droid Sans Mono for Powerline Plus Nerd File Types | 2048 |
| Literation Mono Powerline Plus Nerd File Types | 2048 |
| PragmataPro for Powerline Plus Nerd File Types | 2048 |
| ProggyCleanTT Plus Nerd File Types | 2048 |
| Sauce Code Powerline Plus Nerd File Types | 1000 |
| Ubuntu Mono derivative Powerline Plus Nerd File Types | 1000 |
| Ubuntu Mono Plus Nerd File Types | 1000 |
| Currently Included Absolute Mono Patched Fonts (single width glyphs)| em size |
|---------------------------------------------------------------------|----------|
| Anonymice Powerline Plus Nerd File Types Mono | 2048 |
| Droid Sans Mono for Powerline Plus Nerd File Types Mono | 2048 |
| Literation Mono Powerline Plus Nerd File Types Mono | 2048 |
| PragmataPro for Powerline Plus Nerd File Types Mono | 2048 |
| ProggyCleanTT Plus Nerd File Types Mono | 2048 |
| Sauce Code Powerline Plus Nerd File Types Mono | 1000 |
| Ubuntu Mono derivative Powerline Plus Nerd File Types Mono | 1000 |
| Ubuntu Mono Plus Nerd File Types Mono | 1000 |
## Font Patcher
@ -42,10 +56,30 @@ Patching the font of your own choosing for use with the [vim-webdevicons](https:
> ./font-patcher PATH_TO_FONT
e.g.
```
usage: font-patcher [-h] [-s] [-q] 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
```
### 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 Inconsolata.otf