aboutsummaryrefslogtreecommitdiff
path: root/fonts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fonts/README.md')
-rw-r--r--fonts/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/fonts/README.md b/fonts/README.md
new file mode 100644
index 0000000..b684a17
--- /dev/null
+++ b/fonts/README.md
@@ -0,0 +1,48 @@
+# Nerd Fonts
+
+This is an archived font from the Nerd Fonts release v3.1.1.
+
+For more information see:
+* https://github.com/ryanoasis/nerd-fonts/
+* https://github.com/ryanoasis/nerd-fonts/releases/latest/
+
+# Hack
+
+A typeface designed for source code.
+
+For more information have a look at the upstream website: https://github.com/source-foundry/Hack
+
+Version: 3.003
+
+## 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
+