Skip to content

Commit df582c5

Browse files
committed
Updated readme with better description and explanation of the options available
* updates the changelog as well
1 parent 7dfb9cd commit df582c5

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

changelog.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
- v0.1.2
2+
-- updated readme with better description and explanation of the options available
3+
-- added new unpatched font PragmataPro for Powerline
4+
-- added new patched font PragmataPro for Powerline Plus Nerd File Types
5+
- v0.1.1
6+
-- Fixes scaling issues in first set of glyphs in certain fonts (fixes issue #1)
17
- v0.1.0
28
-- release
3-
-- inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo
9+
-- inital port from 'features/1-script-patch-fonts' branch on vim-webdevicons repo

readme.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
nerd-filetype-glyphs-fonts-patcher
22
==================================
33

4-
Adds filetype glyphs (icons) to any font you pass in or you can simply use one of the provided patched font (see list below)
5-
Created for use with [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons)
4+
* A python fontforge command line script to patch any font for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin
5+
* Adds the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) glyphs (icons) to any font you pass in
6+
* patched-fonts folder contains pre-patched fonts provided for use with [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) [(see list below)](#patched-fonts)
67

78
## Usage
89

9-
Typical install of the patched font or generate a patched font from your own font to get the additional new glyphs.
10+
### Option A
11+
12+
Typical install of any of the [provided patched fonts](#patched-fonts)
13+
14+
or
15+
16+
### Option B
17+
18+
Use the provided python command line script to generate a patched font from your own font to get the additional new glyphs
19+
20+
See: [Font Patcher](#font-patcher) for usage
21+
22+
* use this option if you do __not__ want to use one of the [fonts provided](#patched-fonts)
1023

1124
## Patched Fonts
1225

@@ -15,12 +28,15 @@ Typical install of the patched font or generate a patched font from your own fon
1528
| Anonymice Powerline Plus Nerd File Types | 2048 |
1629
| Droid Sans Mono for Powerline Plus Nerd File Types | 2048 |
1730
| Literation Mono Powerline Plus Nerd File Types | 2048 |
31+
| PragmataPro for Powerline Plus Nerd File Types | 2048 |
1832
| ProggyCleanTT Plus Nerd File Types | 2048 |
1933
| Sauce Code Powerline Plus Nerd File Types | 1000 |
2034
| Ubuntu Mono derivative Powerline Plus Nerd File Types | 1000 |
2135
| Ubuntu Mono Plus Nerd File Types | 1000 |
2236

23-
Patching the font of your own choosing:
37+
## Font Patcher
38+
39+
Patching the font of your own choosing for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin:
2440
* requires: python2, python-fontforge package
2541
* usage:
2642

@@ -29,7 +45,7 @@ Patching the font of your own choosing:
2945
e.g.
3046

3147
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
32-
48+
3349
./font-patcher Inconsolata.otf
3450

3551

0 commit comments

Comments
 (0)