Skip to content

Commit 49b7dfa

Browse files
committed
updated readme for font-patcher usage
updated readme for font-patcher: added table of already patched fonts and example usage of how to patch. removed old font patching coming soon messages added additional example for: add or override individual additional filetypes
1 parent 94b7f2f commit 49b7dfa

File tree

1 file changed

+44
-11
lines changed

1 file changed

+44
-11
lines changed

readme.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,42 @@ Adds filetype glyphs (icons) to other vim plugins such as nerdtree and vim-airli
88
After installing the patched font and setting the vim font just open nerdtree or look at vim-airline (statusline or tabline)
99
* _NOTE:_ if you don't have a vim font set and not running gvim you will need to set the terminal font
1010

11-
## Configuration
11+
## Font Configuration (experimental)
1212

13-
Works without Configuration *ONLY* when used with the patched font provided (see lib folder), install font and add to your vimrc or gvimrc, e.g.:
13+
* The _ONLY_ configuration needed should be setting the font vim uses to a patched font (some are provided)
14+
15+
| Currnetly Included Patched Fonts |
16+
|--------------------------------------------------------|
17+
| Anonymice Powerline Plus Nerd File Types |
18+
| Droid Sans Mono for Powerline Plus Nerd File Types |
19+
| Literation Mono Powerline Plus Nerd File Types |
20+
| ProggyCleanTT Plus Nerd File Types |
21+
| Sauce Code Powerline Plus Nerd File Types |
22+
| Ubuntu Mono derivative Powerline Plus Nerd File Types |
23+
24+
Patching the font of your own choosing:
25+
* requires: python2, python-fontforge package
26+
* usage:
27+
28+
> ./font-patcher PATH_TO_FONT
29+
30+
e.g.
31+
32+
./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
33+
34+
./font-patcher Inconsolata.otf
35+
36+
Works without Configuration *ONLY* when used with the patched font provided (see lib folder), install font and add to your vimrc or gvimrc
1437

1538
```vim
16-
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
39+
set guifont=<FONT_NAME> <FONT_SIZE>
1740
```
1841

19-
* additional fonts coming soon
20-
* font patching coming soon
42+
e.g.
43+
44+
```vim
45+
set guifont=Droid\ Sans\ Mono\ for\ Powerline\ Plus\ Nerd\ File\ Types\ 11
46+
```
2147

2248
## Screenshots
2349

@@ -33,6 +59,10 @@ Works without Configuration *ONLY* when used with the patched font provided (see
3359
* tabline
3460
![image](screenshots/airline-tabline.png)
3561

62+
* Different patched fonts example:
63+
64+
![image](screenshots/different-fonts-sample.png)
65+
3666
## Features
3767
* show developer file type glyphs from a font in various vim plugins, currently supports:
3868
* [NERDTree](https://github.com/scrooloose/nerdtree)
@@ -48,10 +78,10 @@ Works without Configuration *ONLY* when used with the patched font provided (see
4878
* example usage
4979
> ./font-patcher unpatched-sample-fonts/Droid\ Sans\ Mono\ for\ Powerline.otf
5080

51-
## Configuration
81+
## Extra Configuration
5282

5383
* by default you should not *NEED* to configure anything to get the basics working
54-
* _NOTE:_ For the time being you do *NEED* the patched font provided _unless_ you want to configure the filetype to glyph mappings yourself for your current font
84+
* _NOTE:_ You *NEED* to use one of the patched font provided or patch your own _unless_ you want to configure the filetype to glyph mappings yourself for your current font
5585
* these options can be defined in your vimrc or gvimrc
5686
* the following options are provided however for overriding
5787

@@ -88,6 +118,10 @@ Works without Configuration *ONLY* when used with the patched font provided (see
88118
* change the default dictionary mappings for exact file node matches
89119

90120
> let g:WebDevIconsUnicodeDecorateFileNodesExactSymbols = { 'MyReallyCoolFile.okay': 'myreallycoolglyph' }
121+
122+
* add or override individual additional filetypes
123+
124+
> let g:WebDevIconsUnicodeDecorateFileNodesExtensionSymbols['myext'] = 'mysymbol'
91125
92126
## todo
93127

@@ -98,12 +132,11 @@ Works without Configuration *ONLY* when used with the patched font provided (see
98132

99133
## FAQ / Troubleshooting
100134

101-
* I don't want to use font XYZ, I want to use font ABC
102-
* font patching is coming soon
135+
* I don't want to use any of the fonts provided, I want to use font ABC
136+
* see font configuration above
103137

104138
* It isn't working
105-
* Are you using the patched font provided?
106-
* Support for other fonts will come when patching is working
139+
* Are you using the patched font provided or are you patching your own?
107140
* _NOTE:_ if running vim and no font set it will default to the termianl font that is set
108141
* check what the vim/gvim font is set to, from ex mode:
109142

0 commit comments

Comments
 (0)