Skip to content

Commit 3e2dba3

Browse files
committed
doc: Restructure readme
Signed-off-by: Fini Jastrow <[email protected]>
1 parent b53f205 commit 3e2dba3

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

readme.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,26 @@ The following flow diagram shows the current glyph sets included:
2525
</p>
2626
<sub><i>Diagram created using <a href="http://sankeymatic.com/" title="SankeyMATIC (BETA): A Sankey diagram builder for everyone">@SankeyMATIC</a></i></sub>
2727

28+
## TL;DR
29+
Nerd Fonts takes popular programming fonts and adds a bunch of Glyphs.
30+
There is also a [font patcher](#font-patcher) available if your desired font isn't already patched.
31+
For more high level information see the [wiki][wiki]. If you are looking for the Vim plugin see [VimDevIcons ➶][vim-devicons].
2832

29-
## Important Notices
30-
* `master` branch file paths are **not** considered stable. [Verify your repository URI references](#unstable-file-paths)
31-
* cloning this repository is **not** recommended ([due to Repo size](#option-7-clone-the-repo)) unless you are going to be [contributing to development](#contributing)
32-
33+
* `master` branch file paths are **not** considered stable. Verify your repository [URI references](#unstable-file-paths). Use links to the release archives if possible.
34+
* Cloning this repository is **not** recommended ([due to Repo size](#option-7-clone-the-repo)) unless you are going to be [contributing to development](#contributing).
3335

34-
## Table of Contents
3536

36-
[**TL;DR**](#tldr)
37+
## Quick links
3738

38-
[**Installation Options**](#font-installation)
39-
* [**1 - Release Archive Download**](#option-1-release-archive-download)
40-
* [**2 - Homebrew Fonts (macOS (OS X))**](#option-2-homebrew-fonts)
41-
* [**3 - Chocolatey or Scoop (Windows)**](#option-3-unofficial-chocolatey-or-scoop-repositories)
42-
* [**4 - Arch Linux Repository (Extra, AUR)**](#option-4-arch-extra-repository)
43-
* [**5 - Ad Hoc Curl Download**](#option-5-ad-hoc-curl-download)
44-
* [**6 - Install Script**](#option-6-install-script)
45-
* [**7 - Clone Repo**](#option-7-clone-the-repo)
46-
* [**8 - Patch Your Own Font**](#option-8-patch-your-own-font)
39+
[**Installation Options**](#font-installation):
40+
[Release Archive](#option-1-release-archive-download)
41+
[Homebrew](#option-2-homebrew-fonts)
42+
[Chocolatey or Scoop](#option-3-unofficial-chocolatey-or-scoop-repositories)
43+
[Arch](#option-4-arch-extra-repository)
44+
[Curl](#option-5-ad-hoc-curl-download)
45+
[Install Script](#option-6-install-script)
46+
[Clone Repo](#option-7-clone-the-repo)
47+
[Selfpatch](#option-8-patch-your-own-font)
4748

4849
[**Features**](#features)
4950
* [**Glyph/Icon sets**](#glyph-sets)
@@ -65,11 +66,6 @@ The following flow diagram shows the current glyph sets included:
6566
* [**License**](#license)
6667

6768

68-
## TL;DR
69-
Nerd Fonts takes popular programming fonts and adds a bunch of Glyphs.
70-
There is also a [font patcher](#font-patcher) available if your desired font isn't already patched.
71-
For more high level information see the [wiki][wiki]. If you are looking for the Vim plugin see [VimDevIcons ➶][vim-devicons].
72-
7369
### Various Download Options for Fonts
7470

7571
_If you..._
@@ -375,6 +371,8 @@ Patching the font of your own choosing:
375371
```
376372

377373
* Use docker
374+
The patcher's docker image is on [dockerhub][docker]. Note that the _About_ page with manual there is outdated;
375+
refer to the instructions given here.
378376
* Default parallel tasks
379377
```
380378
docker run --rm -v /path/to/fonts:/in:Z -v /path/for/output:/out:Z nerdfonts/patcher [OPTIONS]
@@ -392,7 +390,7 @@ Patching the font of your own choosing:
392390
> [!NOTE]
393391
> The resulting font's family (aka font name) will be set to the original family after CamelCasing, removing whitespace and appending ` Nerd Font`. For example, `iosevka term` would become `IosevkaTerm Nerd Font`.
394392
395-
Full options follow, see also [**page explaining all options**](https://github.com/ryanoasis/nerd-fonts/wiki/ScriptOptions):
393+
Full options follow, see also [**page explaining all options**][scriptoptions]:
396394

397395
```
398396
Nerd Fonts Patcher v3.1.0-6 (4.8.1) (ff 20230101)
@@ -645,6 +643,8 @@ Link References
645643
[coc]:https://github.com/ryanoasis/nerd-fonts/blob/-/code_of_conduct.md "Contributor Covenant Code of Conduct"
646644
[LICENSE]:https://github.com/ryanoasis/nerd-fonts/blob/-/LICENSE
647645
[prs]:http://makeapullrequest.com "Make a Pull Request (external link) ➶"
646+
[docker]:https://hub.docker.com/r/nerdfonts/patcher
647+
[scriptoptions]:https://github.com/ryanoasis/nerd-fonts/wiki/ScriptOptions
648648

649649
<!--
650650
Font repos

0 commit comments

Comments
 (0)