Skip to content

Commit 54d6559

Browse files
committed
#4 Added details of cli parameters and updated fonts list with the true mono spaced fonts
1 parent a7b979e commit 54d6559

File tree

1 file changed

+48
-14
lines changed

1 file changed

+48
-14
lines changed

readme.md

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
nerd-filetype-glyphs-fonts-patcher
2-
==================================
1+
nerd-filetype-glyphs-fonts-patcher v0.2.0
2+
=========================================
33

44
* A python fontforge command line script to patch any font for use with the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) vim plugin
55
* Adds the [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) glyphs (icons) to any font you pass in
66
* patched-fonts folder contains pre-patched fonts provided for use with [vim-webdevicons](https://github.com/ryanoasis/vim-webdevicons) [(see list below)](#patched-fonts)
77

8+
![image](https://github.com/ryanoasis/vim-webdevicons/wiki/screenshots/v0.3.4/fontforge-glyph-set-1.png)
9+
... and more ...
10+
811
## Usage
912

1013
### Option A
@@ -23,16 +26,27 @@ See: [Font Patcher](#font-patcher) for usage
2326

2427
## Patched Fonts
2528

26-
| Currnetly Included Patched Fonts | em size |
27-
|--------------------------------------------------------|----------|
28-
| Anonymice Powerline Plus Nerd File Types | 2048 |
29-
| Droid Sans Mono for Powerline Plus Nerd File Types | 2048 |
30-
| Literation Mono Powerline Plus Nerd File Types | 2048 |
31-
| PragmataPro for Powerline Plus Nerd File Types | 2048 |
32-
| ProggyCleanTT Plus Nerd File Types | 2048 |
33-
| Sauce Code Powerline Plus Nerd File Types | 1000 |
34-
| Ubuntu Mono derivative Powerline Plus Nerd File Types | 1000 |
35-
| Ubuntu Mono Plus Nerd File Types | 1000 |
29+
| Currently Included Patched Fonts (double width glyphs) | em size |
30+
|-------------------------------------------------------------|----------|
31+
| Anonymice Powerline Plus Nerd File Types | 2048 |
32+
| Droid Sans Mono for Powerline Plus Nerd File Types | 2048 |
33+
| Literation Mono Powerline Plus Nerd File Types | 2048 |
34+
| PragmataPro for Powerline Plus Nerd File Types | 2048 |
35+
| ProggyCleanTT Plus Nerd File Types | 2048 |
36+
| Sauce Code Powerline Plus Nerd File Types | 1000 |
37+
| Ubuntu Mono derivative Powerline Plus Nerd File Types | 1000 |
38+
| Ubuntu Mono Plus Nerd File Types | 1000 |
39+
40+
| Currently Included Absolute Mono Patched Fonts (single width glyphs)| em size |
41+
|---------------------------------------------------------------------|----------|
42+
| Anonymice Powerline Plus Nerd File Types Mono | 2048 |
43+
| Droid Sans Mono for Powerline Plus Nerd File Types Mono | 2048 |
44+
| Literation Mono Powerline Plus Nerd File Types Mono | 2048 |
45+
| PragmataPro for Powerline Plus Nerd File Types Mono | 2048 |
46+
| ProggyCleanTT Plus Nerd File Types Mono | 2048 |
47+
| Sauce Code Powerline Plus Nerd File Types Mono | 1000 |
48+
| Ubuntu Mono derivative Powerline Plus Nerd File Types Mono | 1000 |
49+
| Ubuntu Mono Plus Nerd File Types Mono | 1000 |
3650

3751
## Font Patcher
3852

@@ -42,10 +56,30 @@ Patching the font of your own choosing for use with the [vim-webdevicons](https:
4256

4357
> ./font-patcher PATH_TO_FONT
4458

45-
e.g.
59+
```
60+
usage: font-patcher [-h] [-s] [-q] font
4661
47-
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
62+
Patches a given font with programming and web development related glyphs
63+
(mainly for vim-webdevicons)
64+
65+
positional arguments:
66+
font The path to the font to be patched (e.g.
67+
Inconsolata.otf)
4868
69+
optional arguments:
70+
-h, --help show this help message and exit
71+
-s, --use-single-width-glyphs
72+
Whether to generate the glyphs as single-width not
73+
double-width (default is double-width)
74+
-q, --quiet, --shutup
75+
Do not generate verbose output
76+
```
77+
78+
### Examples
79+
80+
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
81+
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf -s -q
82+
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf --use-single-width-glyphs --quiet
4983
./font-patcher Inconsolata.otf
5084

5185

0 commit comments

Comments
 (0)