Updated readme with better description and explanation of the options available

* updates the changelog as well
This commit is contained in:
ryanoasis 2015-01-21 20:04:51 -05:00
parent 7dfb9cd88f
commit df582c527c
2 changed files with 28 additions and 6 deletions

View file

@ -1,3 +1,9 @@
- v0.1.2
-- updated readme with better description and explanation of the options available
-- added new unpatched font PragmataPro for Powerline
-- added new patched font PragmataPro for Powerline Plus Nerd File Types
- v0.1.1
-- Fixes scaling issues in first set of glyphs in certain fonts (fixes issue #1)
- v0.1.0
-- release
-- inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
-- inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo

View file

@ -1,12 +1,25 @@
nerd-filetype-glyphs-fonts-patcher
==================================
Adds filetype glyphs (icons) to any font you pass in or you can simply use one of the provided patched font (see list below)
Created for use with [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons)
* 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)
## Usage
Typical install of the patched font or generate a patched font from your own font to get the additional new glyphs.
### Option A
Typical install of any of the [provided patched fonts](#patched-fonts)
or
### 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
@ -15,12 +28,15 @@ Typical install of the patched font or generate a patched font from your own fon
| 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 |
Patching the font of your own choosing:
## Font Patcher
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
* usage:
@ -29,7 +45,7 @@ Patching the font of your own choosing:
e.g.
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
./font-patcher Inconsolata.otf