fonts/nerd-fonts
1
0
Fork 0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-12-25 20:18:01 +02:00
Code Issues Releases Activity

Update readme.md

Browse Source 
* Misc readability fixes
* Patched Fonts
  * backslash-escape markdown fix
  * left align table
This commit is contained in:
Ryan L McIntyre 2017-04-22 08:26:44 -04:00 committed by GitHub
parent 45895bfbb8
commit 612c255c96
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
readme.md
View File

@ -5,7 +5,7 @@
[![GitHub release][img-version-badge-with-logo]][repo] [![Gitter][img-gitter-badge]][gitter]   [![Windows Logo][w-top]](#patched-fonts)   [![macOS (OSX) Logo][m-top]](#patched-fonts)   [![Linux Logo][l-top]](#patched-fonts) [![GitHub release][img-version-badge-with-logo]][repo] [![Gitter][img-gitter-badge]][gitter]   [![Windows Logo][w-top]](#patched-fonts)   [![macOS (OSX) Logo][m-top]](#patched-fonts)   [![Linux Logo][l-top]](#patched-fonts)
**Nerd Fonts** is a project that patches developer targeted fonts with a high number of glyphs (icons). Specifically to add a high number of extra glyphs from popular 'iconic fonts' such as [Font Awesome][font-awesome], [Devicons][vorillaz-devicons], [Octicons][octicons], and [others](#glyph-sets). **Nerd Fonts** is a project that patches developer targeted fonts with a high number of glyphs (icons). Specifically to add a high number of extra glyphs from popular 'iconic fonts' such as [Font Awesome ➶][font-awesome], [Devicons ➶][vorillaz-devicons], [Octicons ➶][octicons], and [others](#glyph-sets).
The following Sankey flow diagram shows the current glyph sets included: The following Sankey flow diagram shows the current glyph sets included:
@ -126,9 +126,7 @@ The following Sankey flow diagram shows the current glyph sets included:
### Icon names in shell ### Icon names in shell
Download provided `.sh` files from [bin/scripts/lib/](bin/scripts/lib/) Download provided `.sh` files from [bin/scripts/lib/](bin/scripts/lib/) directory somewhere, recommended locations are `~/.local/share/fonts/` or `~/bin/`.
directory somewhere, recommended locations are `~/.local/share/fonts/` or
`~/bin/`.
- `i_all.sh` - helper to load all files you've downloaded at once - `i_all.sh` - helper to load all files you've downloaded at once
- `i_dev.sh` - Devicons (198 icons, 8 does not have an established name) - `i_dev.sh` - Devicons (198 icons, 8 does not have an established name)
@ -137,13 +135,11 @@ directory somewhere, recommended locations are `~/.local/share/fonts/` or
- `i_iec.sh` - IEC Power Symbols (5 icons) - `i_iec.sh` - IEC Power Symbols (5 icons)
- `i_linux.sh` - Font Linux (20 icons) - `i_linux.sh` - Font Linux (20 icons)
- `i_oct.sh` - Octicons (172 icons) - `i_oct.sh` - Octicons (172 icons)
- `i_ple.sh` - Powerline Extra Symbols (37 icons, 2 aliases, 16 does not - `i_ple.sh` - Powerline Extra Symbols (37 icons, 2 aliases, 16 does not have an established name)
have an established name)
- `i_pom.sh` - Pomicons (11 icons) - `i_pom.sh` - Pomicons (11 icons)
- `i_seti.sh` - Seti-UI + Custom (50 icons, 2 aliases, 5 does not have an - `i_seti.sh` - Seti-UI + Custom (50 icons, 2 aliases, 5 does not have an established name)
established name)
Then `source` required file(s) and output `$i_*` variables to see icons: Then `source` the required file(s) and output `$i_*` variables to see icons:
```sh ```sh
source ~/.local/share/fonts/i_oct.sh source ~/.local/share/fonts/i_oct.sh
@ -152,14 +148,13 @@ echo $i_oct_heart
# ♥ # ♥
``` ```
**NOTE:** You have to use one of Nerd fonts to see correct icons for some **NOTE:** You have to use one of the Nerd Fonts to see correct icons for some icon sets (Devicons, Font Awesome Extension, Font Linux), but other sets should work with their standard fonts too.
icon sets (Devicons, Font Awesome Extension, Font Linux), but other sets
should work with their standard fonts too.
## Patched Fonts ## Patched Fonts
| Font Name | Font Name and Repository | *RFN | EM Size | Status | | Font Name | Font Name and Repository |\*RFN | EM Size | Status |
|---------------------------------------------------|-----------------------------|------|---------|-------------------| |:--------------------------------------------------|:----------------------------|:-----|:--------|:------------------|
| [3270 Nerd Font][p-3270] | [3270][f-3270] | NO | 1000 | ![w2] ![m2] ![l2] | | [3270 Nerd Font][p-3270] | [3270][f-3270] | NO | 1000 | ![w2] ![m2] ![l2] |
| [Anonymice Nerd Font][p-anonymous-pro] | [Anonymous Pro][f-a-pro] | NO | 2048 | ![w] ![m2] ![l] | | [Anonymice Nerd Font][p-anonymous-pro] | [Anonymous Pro][f-a-pro] | NO | 2048 | ![w] ![m2] ![l] |
| [Aurulent Sans Mono Nerd Font][p-aurulent] | | NO | 1000 | ![w] ![m2] ![l] | | [Aurulent Sans Mono Nerd Font][p-aurulent] | | NO | 1000 | ![w] ![m2] ![l] |
@ -206,11 +201,11 @@ should work with their standard fonts too.
* `560` 'complete' variations/combinations * `560` 'complete' variations/combinations
* `73,960` _possible_ variations/combinations * `73,960` _possible_ variations/combinations
* `74,520` total calculated combinations (560 + 73,960) * `74,520` total calculated combinations (560 + 73,960)
* Combinations for each font are any combination of (plus no flags option) [Variations](#variations) * Combinations for each font are any combination of [Variations](#variations)
### Variations ### Variations
* no flags given (defaults to only [Seti-UI] and [Devicons][vorillaz-devicons]) * no flags given (defaults to only **Seti-UI + Custom** and **[Devicons][vorillaz-devicons]**)
* *double* (variable/proportional) or *single* (fixed/monospaced) width icons/glyphs * **double _(variable/proportional)_** or **single _(fixed/monospaced)_** width glyphs
* [Font Awesome][font-awesome] * [Font Awesome][font-awesome]
* [Font Awesome Extension][font-awesome-extension] * [Font Awesome Extension][font-awesome-extension]
* [GitHub Octicons][octicons] * [GitHub Octicons][octicons]