Skip to content

Commit

Permalink
Improve 'Unstable File Paths' section
Browse files Browse the repository at this point in the history
* Makes it easier to read and visually grep
* Improves the information provided
* Title change to 'Quick Links' section
  • Loading branch information
ryanoasis authored Apr 1, 2017
1 parent b4421eb commit a4eebd6
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following Sankey flow diagram shows the current glyph sets included:
<sub><i>Diagram created using <a href="http://sankeymatic.com/" title="SankeyMATIC (BETA): A Sankey diagram builder for everyone">@SankeyMATIC</a></i></sub>


## Quick Links
## Quick Navigation

| **[Latest Release ➶][release]** | **[Fonts](#patched-fonts)** | **[Patcher](#font-patcher)** | **[VimDevIcons ➶][vim-devicons]** | **[Font Package <br/>Downloads ➶][release]** |
|:-------------------------------:|:---------------------------:|:----------------------------:|:---------------------------------:|:--------------------------------------------:|
Expand Down Expand Up @@ -376,12 +376,13 @@ See [contributing.md](contributing.md)

## Unstable File Paths

| Unstable file paths warning |
|-----------------------------|
| Reference the **release** branch and _not_ the ~~master~~ branch because paths are subject change for each release |
| For example: |
| Use: https://github.com/ryanoasis/nerd-fonts/blob/0.9.0/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf |
| Not: ~~https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf~~ |
⚠ Warning: File paths may change based on releases (especially **major** version bumps)

Reference the **release** branch and _not_ the ~~master~~ branch because paths are subject change for each release

* For example:
* ✅ Use: https://github.com/ryanoasis/nerd-fonts/blob/0.9.0/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf
* ❌ Instead of: ~~https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hermit/Medium/complete/Hurmit%20Medium%20Nerd%20Font%20Complete.otf~~


## Other Good Fonts to Patch
Expand Down

0 comments on commit a4eebd6

Please sign in to comment.