nerd-fonts/src/readme-per-directory-addendum.md


## Which font?

### TL;DR

* Pick your font family:
  * If you are limited to monospaced fonts (because of your terminal, etc) then pick a font with `Nerd Font Mono` (or `NFM`).
  * If you want to have bigger icons (usually around 1.5 normal letters wide) pick a font without `Mono` i.e. `Nerd Font` (or `NF`). Most terminals support this, but ymmv.
  * If you work in a proportional context (GUI elements or edit a presentation etc) pick a font with `Nerd Font Propo` (or `NFP`).

### Ligatures

Ligatures are generally preserved in the patched fonts.
Nerd Fonts `v2.0.0` had no ligatures in the `Nerd Font Mono` fonts, this has been dropped with `v2.1.0`.
If you have a ligature-aware terminal and don't want ligatures you can (usually) disable them in the terminal settings.

### Explanation

Once you narrow down your font choice of family (`Droid Sans`, `Inconsolata`, etc) and style (`bold`, `italic`, etc) you have 2 main choices:

#### `Option 1: Download already patched font`

 * For a stable version download a font package from the [release page](https://github.com/ryanoasis/nerd-fonts/releases)
 * Or download the development version from the folders here

#### `Option 2: Patch your own font`

 * Patch your own variations with the various options provided by the font patcher (i.e. not include all symbols for smaller font size)

For more information see: [The FAQ](https://github.com/ryanoasis/nerd-fonts/wiki/FAQ-and-Troubleshooting#which-font)

[SIL-RFN]:http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web_fonts_and_RFNs#14cbfd4a
Moves build related helper md and un-patched fonts to 'src' 2016-10-29 16:48:12 -04:00
			`## Which font?`

			`### TL;DR`

Drop "complete/" subdirs [why] Since we do not have any other variations anymore it does not make sense to keep that directory. The renaming with 3.0.0 is a good point in time to drop it as the filename scheme changes anyhow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2023-04-28 11:42:12 +02:00			`* Pick your font family:`
Correct readme template Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2023-04-25 17:24:37 +02:00			* If you are limited to monospaced fonts (because of your terminal, etc) then pick a font with `Nerd Font Mono` (or `NFM`).
			* If you want to have bigger icons (usually around 1.5 normal letters wide) pick a font without `Mono` i.e. `Nerd Font` (or `NF`). Most terminals support this, but ymmv.
			* If you work in a proportional context (GUI elements or edit a presentation etc) pick a font with `Nerd Font Propo` (or `NFP`).
Moves build related helper md and un-patched fonts to 'src' 2016-10-29 16:48:12 -04:00
Document which Fura Code variant to use for ligatures 2019-01-15 01:03:33 +01:00			`### Ligatures`

Sunset ligature removal [why] Keeping the ligature removal tables up to date with source font updates is quite a maintenance burden. Usually if a terminal supports ligatures at all it has an option to disable them. Present ligatures do not prevent monospaced fonts and monospaced detection. It was only present in v2.0.0, and the code has been broken with v2.1.0. [note] Updated example ligature removal table to the one for Iosevka. Left stubs in relevant code passages to facilitate finding this commit. Fixes: #976 Fixes: #975 Fixes: #973 Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2022-10-20 08:16:34 +02:00			`Ligatures are generally preserved in the patched fonts.`
			Nerd Fonts `v2.0.0` had no ligatures in the `Nerd Font Mono` fonts, this has been dropped with `v2.1.0`.
			`If you have a ligature-aware terminal and don't want ligatures you can (usually) disable them in the terminal settings.`
Document which Fura Code variant to use for ligatures 2019-01-15 01:03:33 +01:00
Moves build related helper md and un-patched fonts to 'src' 2016-10-29 16:48:12 -04:00			`### Explanation`

Updates Explanation options sections 2017-07-16 16:38:13 -04:00			Once you narrow down your font choice of family (`Droid Sans`, `Inconsolata`, etc) and style (`bold`, `italic`, etc) you have 2 main choices:

			#### `Option 1: Download already patched font`

Sunset ligature removal [why] Keeping the ligature removal tables up to date with source font updates is quite a maintenance burden. Usually if a terminal supports ligatures at all it has an option to disable them. Present ligatures do not prevent monospaced fonts and monospaced detection. It was only present in v2.0.0, and the code has been broken with v2.1.0. [note] Updated example ligature removal table to the one for Iosevka. Left stubs in relevant code passages to facilitate finding this commit. Fixes: #976 Fixes: #975 Fixes: #973 Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2022-10-20 08:16:34 +02:00			`* For a stable version download a font package from the [release page](https://github.com/ryanoasis/nerd-fonts/releases)`
Correct readme template Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2023-04-25 17:24:37 +02:00			`* Or download the development version from the folders here`
Updates Explanation options sections 2017-07-16 16:38:13 -04:00
			#### `Option 2: Patch your own font`

Correct readme template Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de> 2023-04-25 17:24:37 +02:00			`* Patch your own variations with the various options provided by the font patcher (i.e. not include all symbols for smaller font size)`
Moves build related helper md and un-patched fonts to 'src' 2016-10-29 16:48:12 -04:00
fixed links 2017-07-28 16:29:44 -04:00			`For more information see: [The FAQ](https://github.com/ryanoasis/nerd-fonts/wiki/FAQ-and-Troubleshooting#which-font)`
Moves build related helper md and un-patched fonts to 'src' 2016-10-29 16:48:12 -04:00
Adds and updates configuration files to support RFN identifiers (fixes #136) 2017-07-23 17:38:55 -04:00			`[SIL-RFN]:http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web_fonts_and_RFNs#14cbfd4a`