diff --git a/readme.md b/readme.md index bf3f9b09e6f..645acc170ba 100644 --- a/readme.md +++ b/readme.md @@ -339,36 +339,30 @@ See: [Font Patcher](#font-patcher) for usage Nerd Fonts Patcher -Patching the font of your own choosing for use with the [VimDevIcons ➶][vim-devicons]: -* requires: Python 2 (or Python 3), `python-fontforge` package (version `20141231` or later, see - the [install instructions](http://designwithfontforge.com/en-US/Installing_Fontforge.html)) -* alternative install method on OSX: `brew install fontforge` -* alternative method on Linux: Using the [AppImage](https://github.com/fontforge/fontforge/releases) -* alternative method using Docker: [Docker Hub](https://hub.docker.com/r/nerdfonts/patcher) -* Usage: - +Patching the font of your own choosing: +* Use the script + * Download script and its helper files as [Archive](https://github.com/ryanoasis/nerd-fonts/releases/latest/download/FontPatcher.zip) and extract + * requires: Fontforge, Python 3, `python-fontforge` and `argparse` packages + * Fontforge can be installed as package + * or on OSX via `brew install fontforge` + * or as [AppImage](https://github.com/fontforge/fontforge/releases) + * Usage, recommended: ``` - ./font-patcher PATH_TO_FONT + fontforge -script font-patcher PATH_TO_FONT ``` - -* Alternative usage: Execute the patcher with the FontForge binary using the script flag: - + * Usage, direct (more convenient call, if it works for you): ``` - fontforge -script font-patcher PATH_TO_FONT + ./font-patcher PATH_TO_FONT ``` - -* Patching fonts using the AppImage: - - _Note_: `chmod u+x` the AppImage after download. All supplied paths need to be **absolute** and an explicit output path is required! If everything is located in the same directory, you can use the `$PWD` shorthand. - + * Usage, with Fontforge AppImage + _Note_: `chmod u+x` the AppImage after download. All supplied paths need to be **absolute** and an explicit output path is required! If everything is located in the same directory, you can use the `$PWD` shorthand. ``` ./FontForge.AppImage -script $PWD/font-patcher $PWD/BaseFont.ttf -out /tmp ``` - -* Patching fonts with Docker: +* Use docker ``` - docker run -v /path/to/fonts:/in -v /path/for/output:/out nerdfonts/patcher [OPTIONS] + docker run --rm -v /path/to/fonts:/in -v /path/for/output:/out nerdfonts/patcher [OPTIONS] ``` Full options: @@ -484,6 +478,12 @@ docker run --rm -v ~/Desktop/myfont/patchme:/in -v ~/Desktop/myfont/patched:/out ./gotta-patch-em-all-font-patcher\!.sh Hermit ``` +* or to specific directory name start: + + ``` + ./gotta-patch-em-all-font-patcher\!.sh /Heavy + ``` + ## Contributing See [contributing.md](contributing.md)